1 /* Copyright (C) <2018> Philippe Normand <philn@igalia.com>
2 * Copyright (C) <2018> Žan Doberšek <zdobersek@igalia.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 * SECTION:element-wpesrc
24 * The wpesrc element is used to produce a video texture representing a web page
25 * rendered off-screen by WPE.
27 * ## Example launch line
30 * gst-launch-1.0 -v wpesrc location="https://gstreamer.freedesktop.org" ! queue ! glimagesink
32 * Shows the GStreamer website homepage
35 * gst-play-1.0 --videosink gtkglsink wpe://https://gstreamer.freedesktop.org
37 * Shows the GStreamer website homepage as played with GstPlayer in a GTK+ window.
40 * gst-launch-1.0 glvideomixer name=m sink_1::zorder=0 ! glimagesink wpesrc location="file:///home/phil/Downloads/plunk/index.html" draw-background=0 ! m. videotestsrc ! queue ! glupload ! glcolorconvert ! m.
42 * Composite WPE with a video stream in a single OpenGL scene.
45 * gst-launch-1.0 glvideomixer name=m sink_1::zorder=0 sink_0::height=818 sink_0::width=1920 ! gtkglsink wpesrc location="file:///home/phil/Downloads/plunk/index.html" draw-background=0 ! m. uridecodebin uri="http://192.168.1.44/Sintel.2010.1080p.mkv" name=d d. ! queue ! glupload ! glcolorconvert ! m.
47 * Composite WPE with a video stream, sink_0 pad properties have to match the video dimensions.
52 * - Audio support (requires an AudioSession implementation in WebKit and a WPEBackend-fdo API for it)
53 * - DMABuf support (requires changes in WPEBackend-fdo to expose DMABuf planes and fds)
54 * - Custom EGLMemory allocator
55 * - Better navigation events handling (would require a new GstNavigation API)
62 #include "gstwpesrc.h"
63 #include <gst/gl/gl.h>
64 #include <gst/gl/egl/gstglmemoryegl.h>
65 #include <gst/gl/wayland/gstgldisplay_wayland.h>
66 #include <gst/video/video.h>
67 #include <xkbcommon/xkbcommon.h>
69 #include "WPEThreadedView.h"
71 GST_DEBUG_CATEGORY (wpe_src_debug);
72 #define GST_CAT_DEFAULT wpe_src_debug
74 #define DEFAULT_WIDTH 1920
75 #define DEFAULT_HEIGHT 1080
76 #define DEFAULT_FPS_N 30
77 #define DEFAULT_FPS_D 1
88 SIGNAL_CONFIGURE_WEB_VIEW,
92 static guint gst_wpe_src_signals[LAST_SIGNAL] = { 0 };
98 WPEThreadedView *view;
102 gboolean draw_background;
107 static void gst_wpe_src_uri_handler_init (gpointer iface, gpointer data);
109 #define gst_wpe_src_parent_class parent_class
110 G_DEFINE_TYPE_WITH_CODE (GstWpeSrc, gst_wpe_src, GST_TYPE_GL_BASE_SRC,
111 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_wpe_src_uri_handler_init));
113 static GstStaticPadTemplate src_factory = GST_STATIC_PAD_TEMPLATE ("src",
116 GST_STATIC_CAPS ("video/x-raw(memory:GLMemory), "
117 "format = (string) RGBA, "
118 "width = " GST_VIDEO_SIZE_RANGE ", "
119 "height = " GST_VIDEO_SIZE_RANGE ", "
120 "framerate = " GST_VIDEO_FPS_RANGE ", "
121 "pixel-aspect-ratio = (fraction)1/1," "texture-target = (string)2D")
125 gst_wpe_src_fill_memory (GstGLBaseSrc * bsrc, GstGLMemory * memory)
127 GstWpeSrc *src = GST_WPE_SRC (bsrc);
128 const GstGLFuncs *gl;
130 GstEGLImage *locked_image;
132 if (!gst_gl_context_check_feature (GST_GL_CONTEXT (bsrc->context),
133 "EGL_KHR_image_base")) {
134 GST_ERROR_OBJECT (src, "EGL_KHR_image_base is not supported");
138 GST_OBJECT_LOCK (src);
140 gl = bsrc->context->gl_vtable;
141 tex_id = gst_gl_memory_get_texture_id (memory);
142 locked_image = src->view->image ();
145 GST_OBJECT_UNLOCK (src);
149 gl->ActiveTexture (GL_TEXTURE0 + memory->plane);
150 gl->BindTexture (GL_TEXTURE_2D, tex_id);
151 gl->EGLImageTargetTexture2D (GL_TEXTURE_2D,
152 gst_egl_image_get_image (locked_image));
154 GST_OBJECT_UNLOCK (src);
159 gst_wpe_src_gl_start (GstGLBaseSrc * base_src)
161 GstWpeSrc *src = GST_WPE_SRC (base_src);
162 gboolean result = TRUE;
164 GST_INFO_OBJECT (src, "Starting up");
165 GST_OBJECT_LOCK (src);
166 src->view = new WPEThreadedView;
167 result = src->view->initialize (src, base_src->context, base_src->display,
168 GST_VIDEO_INFO_WIDTH (&base_src->out_info),
169 GST_VIDEO_INFO_HEIGHT (&base_src->out_info));
171 if (src->bytes != NULL) {
172 src->view->loadData (src->bytes);
173 g_bytes_unref (src->bytes);
177 GST_OBJECT_UNLOCK (src);
179 GST_ELEMENT_ERROR (src, RESOURCE, FAILED,
180 ("WPEBackend-FDO EGL display initialisation failed"), (NULL));
186 gst_wpe_src_gl_stop (GstGLBaseSrc * base_src)
188 GstWpeSrc *src = GST_WPE_SRC (base_src);
196 gst_wpe_src_fixate (GstBaseSrc * base_src, GstCaps * caps)
198 GstWpeSrc *src = GST_WPE_SRC (base_src);
199 GstStructure *structure;
202 caps = gst_caps_make_writable (caps);
203 structure = gst_caps_get_structure (caps, 0);
205 gst_structure_fixate_field_nearest_int (structure, "width", DEFAULT_WIDTH);
206 gst_structure_fixate_field_nearest_int (structure, "height", DEFAULT_HEIGHT);
208 if (gst_structure_has_field (structure, "framerate"))
209 gst_structure_fixate_field_nearest_fraction (structure, "framerate",
210 DEFAULT_FPS_N, DEFAULT_FPS_D);
212 gst_structure_set (structure, "framerate", GST_TYPE_FRACTION, DEFAULT_FPS_N,
213 DEFAULT_FPS_D, NULL);
215 caps = GST_BASE_SRC_CLASS (parent_class)->fixate (base_src, caps);
216 GST_INFO_OBJECT (base_src, "Fixated caps to %" GST_PTR_FORMAT, caps);
219 gst_structure_get (structure, "width", G_TYPE_INT, &width, "height", G_TYPE_INT, &height, NULL);
220 src->view->resize (width, height);
226 gst_wpe_src_configure_web_view (GstWpeSrc * src, WebKitWebView * webview)
228 GValue args[2] = { {0}, {0} };
230 g_value_init (&args[0], GST_TYPE_ELEMENT);
231 g_value_set_object (&args[0], src);
232 g_value_init (&args[1], G_TYPE_OBJECT);
233 g_value_set_object (&args[1], webview);
235 g_signal_emitv (args, gst_wpe_src_signals[SIGNAL_CONFIGURE_WEB_VIEW], 0,
238 g_value_unset (&args[0]);
239 g_value_unset (&args[1]);
243 gst_wpe_src_load_bytes (GstWpeSrc * src, GBytes * bytes)
245 if (src->view && GST_STATE (GST_ELEMENT_CAST (src)) > GST_STATE_NULL)
246 src->view->loadData (bytes);
248 src->bytes = g_bytes_ref (bytes);
252 gst_wpe_src_set_location (GstWpeSrc * src, const gchar * location,
255 g_free (src->location);
256 src->location = g_strdup (location);
258 src->view->loadUri (src->location);
264 gst_wpe_src_set_draw_background (GstWpeSrc * src, gboolean draw_background)
267 src->view->setDrawBackground (draw_background);
268 src->draw_background = draw_background;
272 gst_wpe_src_set_property (GObject * object, guint prop_id, const GValue * value,
275 GstWpeSrc *src = GST_WPE_SRC (object);
280 const gchar *location;
282 location = g_value_get_string (value);
283 if (location == NULL) {
284 GST_WARNING_OBJECT (src, "location property cannot be NULL");
288 if (!gst_wpe_src_set_location (src, location, NULL)) {
289 GST_WARNING_OBJECT (src, "badly formatted location");
294 case PROP_DRAW_BACKGROUND:
295 gst_wpe_src_set_draw_background (src, g_value_get_boolean (value));
303 gst_wpe_src_get_property (GObject * object, guint prop_id, GValue * value,
306 GstWpeSrc *src = GST_WPE_SRC (object);
310 g_value_set_string (value, src->location);
312 case PROP_DRAW_BACKGROUND:
313 g_value_set_boolean (value, src->draw_background);
316 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
322 gst_wpe_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
324 gboolean ret = FALSE;
325 GstWpeSrc *src = GST_WPE_SRC (parent);
327 if (GST_EVENT_TYPE (event) == GST_EVENT_NAVIGATION) {
332 GST_DEBUG_OBJECT (src, "Processing event %" GST_PTR_FORMAT, event);
336 switch (gst_navigation_event_get_type (event)) {
337 case GST_NAVIGATION_EVENT_KEY_PRESS:
338 case GST_NAVIGATION_EVENT_KEY_RELEASE:
339 if (gst_navigation_event_parse_key_event (event, &key)) {
340 /* FIXME: This is wrong... The GstNavigation API should pass
341 hardware-level information, not high-level keysym strings */
343 (uint32_t) xkb_keysym_from_name (key, XKB_KEYSYM_NO_FLAGS);
344 struct wpe_input_keyboard_event wpe_event;
345 wpe_event.key_code = keysym;
347 gst_navigation_event_get_type (event) ==
348 GST_NAVIGATION_EVENT_KEY_PRESS;
349 wpe_view_backend_dispatch_keyboard_event (src->view->backend (),
354 case GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS:
355 case GST_NAVIGATION_EVENT_MOUSE_BUTTON_RELEASE:
356 if (gst_navigation_event_parse_mouse_button_event (event, &button, &x,
358 struct wpe_input_pointer_event wpe_event;
359 wpe_event.type = wpe_input_pointer_event_type_button;
360 wpe_event.x = (int) x;
361 wpe_event.y = (int) y;
363 wpe_event.modifiers = wpe_input_pointer_modifier_button1;
364 } else if (button == 2) {
365 wpe_event.modifiers = wpe_input_pointer_modifier_button2;
366 } else if (button == 3) {
367 wpe_event.modifiers = wpe_input_pointer_modifier_button3;
368 } else if (button == 4) {
369 wpe_event.modifiers = wpe_input_pointer_modifier_button4;
370 } else if (button == 5) {
371 wpe_event.modifiers = wpe_input_pointer_modifier_button5;
373 wpe_event.button = button;
376 gst_navigation_event_get_type (event) ==
377 GST_NAVIGATION_EVENT_MOUSE_BUTTON_PRESS;
378 wpe_view_backend_dispatch_pointer_event (src->view->backend (),
383 case GST_NAVIGATION_EVENT_MOUSE_MOVE:
384 if (gst_navigation_event_parse_mouse_move_event (event, &x, &y)) {
385 struct wpe_input_pointer_event wpe_event;
386 wpe_event.type = wpe_input_pointer_event_type_motion;
387 wpe_event.x = (int) x;
388 wpe_event.y = (int) y;
389 wpe_view_backend_dispatch_pointer_event (src->view->backend (),
397 /* FIXME: No touch events handling support in GstNavigation */
401 ret = gst_pad_event_default (pad, parent, event);
407 gst_wpe_src_init (GstWpeSrc * src)
409 GstPad *pad = gst_element_get_static_pad (GST_ELEMENT_CAST (src), "src");
411 gst_pad_set_event_function (pad, gst_wpe_src_event);
412 gst_object_unref (pad);
414 src->draw_background = TRUE;
416 gst_base_src_set_live (GST_BASE_SRC_CAST (src), TRUE);
420 gst_wpe_src_uri_get_type (GType)
425 static const gchar *const *
426 gst_wpe_src_get_protocols (GType)
428 static const char *protocols[] = { "wpe", NULL };
433 gst_wpe_src_get_uri (GstURIHandler * handler)
435 GstWpeSrc *src = GST_WPE_SRC (handler);
436 return g_strdup_printf ("wpe://%s", src->location);
440 gst_wpe_src_set_uri (GstURIHandler * handler, const gchar * uri,
443 GstWpeSrc *src = GST_WPE_SRC (handler);
445 return gst_wpe_src_set_location (src, uri + 6, error);
449 gst_wpe_src_uri_handler_init (gpointer iface_ptr, gpointer data)
451 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) iface_ptr;
453 iface->get_type = gst_wpe_src_uri_get_type;
454 iface->get_protocols = gst_wpe_src_get_protocols;
455 iface->get_uri = gst_wpe_src_get_uri;
456 iface->set_uri = gst_wpe_src_set_uri;
460 gst_wpe_src_class_init (GstWpeSrcClass * klass)
462 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
463 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
464 GstGLBaseSrcClass *gl_base_src_class = GST_GL_BASE_SRC_CLASS (klass);
465 GstBaseSrcClass *base_src_class = GST_BASE_SRC_CLASS (klass);
467 gobject_class->set_property = gst_wpe_src_set_property;
468 gobject_class->get_property = gst_wpe_src_get_property;
470 g_object_class_install_property (gobject_class, PROP_LOCATION,
471 g_param_spec_string ("location", "location",
472 "The URL to display",
473 "", (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
474 g_object_class_install_property (gobject_class, PROP_DRAW_BACKGROUND,
475 g_param_spec_boolean ("draw-background", "Draws the background",
476 "Whether to draw the WebView background", TRUE,
477 (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
479 gst_element_class_set_static_metadata (gstelement_class,
480 "WPE source", "Source/Video",
481 "Creates a video stream from a WPE browser",
482 "Philippe Normand <philn@igalia.com>, Žan Doberšek <zdobersek@igalia.com>");
484 gst_element_class_add_static_pad_template (gstelement_class, &src_factory);
486 base_src_class->fixate = GST_DEBUG_FUNCPTR (gst_wpe_src_fixate);
488 gl_base_src_class->supported_gl_api =
489 static_cast < GstGLAPI >
490 (GST_GL_API_OPENGL | GST_GL_API_OPENGL3 | GST_GL_API_GLES2);
491 gl_base_src_class->gl_start = GST_DEBUG_FUNCPTR (gst_wpe_src_gl_start);
492 gl_base_src_class->gl_stop = GST_DEBUG_FUNCPTR (gst_wpe_src_gl_stop);
493 gl_base_src_class->fill_gl_memory =
494 GST_DEBUG_FUNCPTR (gst_wpe_src_fill_memory);
497 * GstWpeSrc::configure-web-view:
498 * @src: the object which received the signal
499 * @webview: the webView
501 * Allow application to configure the webView settings.
503 gst_wpe_src_signals[SIGNAL_CONFIGURE_WEB_VIEW] =
504 g_signal_new ("configure-web-view", G_TYPE_FROM_CLASS (klass),
505 G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
506 G_TYPE_NONE, 1, G_TYPE_OBJECT);
509 * GstWpeSrc::load-bytes:
510 * @src: the object which received the signal
511 * @bytes: the GBytes data to load
513 * Load the specified bytes into the internal webView.
515 gst_wpe_src_signals[SIGNAL_LOAD_BYTES] =
516 g_signal_new_class_handler ("load-bytes", G_TYPE_FROM_CLASS (klass),
517 static_cast < GSignalFlags > (G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION),
518 G_CALLBACK (gst_wpe_src_load_bytes), NULL, NULL,
519 g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_BYTES);
523 plugin_init (GstPlugin * plugin)
525 GST_DEBUG_CATEGORY_INIT (wpe_src_debug, "wpesrc", 0, "WPE Source");
527 return gst_element_register (plugin, "wpesrc", GST_RANK_NONE,
531 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_VERSION_MINOR,
532 wpe, "WPE src plugin", plugin_init, VERSION, GST_LICENSE, PACKAGE,