Commit 3f7e29d5 authored by Nirbheek Chauhan's avatar Nirbheek Chauhan 🐜

Add new 'proxy' element to stream data between pipelines

This keep-it-simple plugin is useful when you want to pipe arbitrary
data to a different pipeline within the same process. Some advantages
over appsink/appsrc, the inter elements, etc:

* Ease of use. Buffers, events, and caps are transmitted as-is without
  copying or serialization.
* Enables zerocopy (especially DMABUF) transparently without any
  special-casing.
* Enables usage with sinks or elements that are unreliable and may
  throw errors and need re-initialization, such as a network sink, a
  USB device sink (v4l2), etc.
* Transmits arbitrary data, not just audio/video/subs
* Can easily implement 1 producer pipeline -> N dynamic consumer
  pipelines within a single process when combined with the `tee`
  element.

All queries, events, buffers, and buffer lists are proxied. State
changes, clocks, and base times for the two pipelines are independent
since the upstream and downstreams continue to be different pipelines.

https://bugzilla.gnome.org/show_bug.cgi?id=788200
parent c5c69dcc
......@@ -461,6 +461,7 @@ AG_GST_CHECK_PLUGIN(netsim)
AG_GST_CHECK_PLUGIN(onvif)
AG_GST_CHECK_PLUGIN(pcapparse)
AG_GST_CHECK_PLUGIN(pnm)
AG_GST_CHECK_PLUGIN(proxy)
AG_GST_CHECK_PLUGIN(rawparse)
AG_GST_CHECK_PLUGIN(removesilence)
AG_GST_CHECK_PLUGIN(sdp)
......@@ -2663,6 +2664,7 @@ gst/netsim/Makefile
gst/onvif/Makefile
gst/pcapparse/Makefile
gst/pnm/Makefile
gst/proxy/Makefile
gst/rawparse/Makefile
gst/removesilence/Makefile
gst/sdp/Makefile
......
......@@ -42,6 +42,7 @@ subdir('netsim')
subdir('onvif')
subdir('pcapparse')
subdir('pnm')
subdir('proxy')
subdir('rawparse')
subdir('removesilence')
subdir('sdp')
......
plugin_LTLIBRARIES = libgstproxy.la
libgstproxy_la_SOURCES = \
gstproxy.c \
gstproxysink.c \
gstproxysrc.c
noinst_HEADERS = \
gstproxysink.h \
gstproxysrc.h \
gstproxy-priv.h
libgstproxy_la_CFLAGS = $(GST_CFLAGS)
libgstproxy_la_LIBADD = $(GST_LIBS)
libgstproxy_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS)
libgstproxy_la_LIBTOOLFLAGS = $(GST_PLUGIN_LIBTOOLFLAGS)
gstproxytest_SOURCES = \
gstproxytest.c
gstproxytest_CFLAGS = \
$(GST_PLUGINS_BASE_CFLAGS) \
$(GST_CFLAGS)
gstproxytest_LDADD = \
$(GST_PLUGINS_BASE_LIBS) \
$(GST_LIBS)
/*
* Copyright (C) 2018 Centricular Ltd.
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_PROXY_PRIV_H__
#define __GST_PROXY_PRIV_H__
#include "gstproxysrc.h"
#include "gstproxysink.h"
G_BEGIN_DECLS
void gst_proxy_sink_set_proxysrc (GstProxySink *sink, GstProxySrc *src);
GstPad* gst_proxy_sink_get_internal_sinkpad (GstProxySink *sink);
GstPad* gst_proxy_src_get_internal_srcpad (GstProxySrc *src);
G_END_DECLS
#endif /* __GST_PROXY_PRIV_H__ */
/*
* Copyright (C) 2015 Centricular Ltd.
* Author: Sebastian Dröge <sebastian@centricular.com>
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Suite 500,
* Boston, MA 02110-1335, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstproxysrc.h"
#include "gstproxysink.h"
static gboolean
plugin_init (GstPlugin * plugin)
{
gst_element_register (plugin, "proxysrc", GST_RANK_NONE, GST_TYPE_PROXY_SRC);
gst_element_register (plugin, "proxysink", GST_RANK_NONE,
GST_TYPE_PROXY_SINK);
return TRUE;
}
GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
GST_VERSION_MINOR,
proxy,
"plugin for proxied inter-pipeline communication",
plugin_init, VERSION, "LGPL", "gstproxy", "http://centricular.com")
/*
* Copyright (C) 2018 Centricular Ltd.
* Author: Sebastian Dröge <sebastian@centricular.com>
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:element-proxysink
* @title: proxysink
*
* Proxysink is a sink element that proxies events, queries, and buffers to
* another pipeline that contains a matching proxysrc element. The purpose is
* to allow two decoupled pipelines to function as though they are one without
* having to manually shuttle buffers, events, queries, etc between the two.
*
* This element also copies sticky events onto the matching proxysrc element.
*
* For example usage, see proxysrc.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstproxysink.h"
#include "gstproxysrc.h"
#include "gstproxy-priv.h"
#define GST_CAT_DEFAULT gst_proxy_sink_debug
GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS_ANY);
struct _GstProxySinkPrivate
{
GstPad *sinkpad;
/* The proxysrc that we push events, buffers, queries to */
GWeakRef proxysrc;
/* Whether there are sticky events pending */
gboolean pending_sticky_events;
};
/* We're not subclassing from basesink because we don't want any of the special
* handling it has for events/queries/etc. We just pass-through everything. */
/* Unlink proxysrc, we don't contain any elements so our parent is GstElement */
#define parent_class gst_proxy_sink_parent_class
G_DEFINE_TYPE (GstProxySink, gst_proxy_sink, GST_TYPE_ELEMENT);
static gboolean gst_proxy_sink_sink_query (GstPad * pad, GstObject * parent,
GstQuery * query);
static GstFlowReturn gst_proxy_sink_sink_chain (GstPad * pad,
GstObject * parent, GstBuffer * buffer);
static GstFlowReturn gst_proxy_sink_sink_chain_list (GstPad * pad,
GstObject * parent, GstBufferList * list);
static gboolean gst_proxy_sink_sink_event (GstPad * pad, GstObject * parent,
GstEvent * event);
static GstStateChangeReturn gst_proxy_sink_change_state (GstElement * element,
GstStateChange transition);
static void
gst_proxy_sink_class_init (GstProxySinkClass * klass)
{
GstElementClass *gstelement_class = (GstElementClass *) klass;
GST_DEBUG_CATEGORY_INIT (gst_proxy_sink_debug, "proxysink", 0, "proxy sink");
g_type_class_add_private (klass, sizeof (GstProxySinkPrivate));
gstelement_class->change_state = gst_proxy_sink_change_state;
gst_element_class_add_pad_template (gstelement_class,
gst_static_pad_template_get (&sink_template));
gst_element_class_set_static_metadata (gstelement_class, "Proxy Sink",
"Sink", "Proxy source for internal process communication",
"Sebastian Dröge <sebastian@centricular.com>");
}
static void
gst_proxy_sink_init (GstProxySink * self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GST_TYPE_PROXY_SINK,
GstProxySinkPrivate);
self->priv->sinkpad =
gst_pad_new_from_static_template (&sink_template, "sink");
gst_pad_set_chain_function (self->priv->sinkpad,
GST_DEBUG_FUNCPTR (gst_proxy_sink_sink_chain));
gst_pad_set_chain_list_function (self->priv->sinkpad,
GST_DEBUG_FUNCPTR (gst_proxy_sink_sink_chain_list));
gst_pad_set_event_function (self->priv->sinkpad,
GST_DEBUG_FUNCPTR (gst_proxy_sink_sink_event));
gst_pad_set_query_function (self->priv->sinkpad,
GST_DEBUG_FUNCPTR (gst_proxy_sink_sink_query));
gst_element_add_pad (GST_ELEMENT (self), self->priv->sinkpad);
}
static GstStateChangeReturn
gst_proxy_sink_change_state (GstElement * element, GstStateChange transition)
{
GstElementClass *gstelement_class =
GST_ELEMENT_CLASS (gst_proxy_sink_parent_class);
GstProxySink *self = GST_PROXY_SINK (element);
GstStateChangeReturn ret;
switch (transition) {
case GST_STATE_CHANGE_READY_TO_PAUSED:
self->priv->pending_sticky_events = FALSE;
break;
default:
break;
}
ret = gstelement_class->change_state (element, transition);
return ret;
}
static gboolean
gst_proxy_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
{
GstProxySink *self = GST_PROXY_SINK (parent);
GstProxySrc *src;
gboolean ret = FALSE;
GST_LOG_OBJECT (pad, "Handling query of type '%s'",
gst_query_type_get_name (GST_QUERY_TYPE (query)));
src = g_weak_ref_get (&self->priv->proxysrc);
if (src) {
GstPad *srcpad;
srcpad = gst_proxy_src_get_internal_srcpad (src);
ret = gst_pad_peer_query (srcpad, query);
gst_object_unref (srcpad);
gst_object_unref (src);
}
return ret;
}
typedef struct
{
GstPad *otherpad;
GstFlowReturn ret;
} CopyStickyEventsData;
static gboolean
copy_sticky_events (G_GNUC_UNUSED GstPad * pad, GstEvent ** event,
gpointer user_data)
{
CopyStickyEventsData *data = user_data;
data->ret = gst_pad_store_sticky_event (data->otherpad, *event);
return data->ret == GST_FLOW_OK;
}
static gboolean
gst_proxy_sink_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
{
GstProxySink *self = GST_PROXY_SINK (parent);
GstProxySrc *src;
gboolean ret = FALSE;
gboolean sticky = GST_EVENT_IS_STICKY (event);
GST_LOG_OBJECT (pad, "Got %s event", GST_EVENT_TYPE_NAME (event));
if (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP)
self->priv->pending_sticky_events = FALSE;
src = g_weak_ref_get (&self->priv->proxysrc);
if (src) {
GstPad *srcpad;
srcpad = gst_proxy_src_get_internal_srcpad (src);
if (sticky && self->priv->pending_sticky_events) {
CopyStickyEventsData data = { srcpad, GST_FLOW_OK };
gst_pad_sticky_events_foreach (pad, copy_sticky_events, &data);
self->priv->pending_sticky_events = data.ret != GST_FLOW_OK;
}
ret = gst_pad_push_event (srcpad, event);
gst_object_unref (srcpad);
gst_object_unref (src);
if (!ret && sticky) {
self->priv->pending_sticky_events = TRUE;
ret = TRUE;
}
} else
gst_event_unref (event);
return ret;
}
static GstFlowReturn
gst_proxy_sink_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
{
GstProxySink *self = GST_PROXY_SINK (parent);
GstProxySrc *src;
GstFlowReturn ret = GST_FLOW_OK;
GST_LOG_OBJECT (pad, "Chaining buffer %p", buffer);
src = g_weak_ref_get (&self->priv->proxysrc);
if (src) {
GstPad *srcpad;
srcpad = gst_proxy_src_get_internal_srcpad (src);
if (self->priv->pending_sticky_events) {
CopyStickyEventsData data = { srcpad, GST_FLOW_OK };
gst_pad_sticky_events_foreach (pad, copy_sticky_events, &data);
self->priv->pending_sticky_events = data.ret != GST_FLOW_OK;
}
ret = gst_pad_push (srcpad, buffer);
gst_object_unref (srcpad);
gst_object_unref (src);
GST_LOG_OBJECT (pad, "Chained buffer %p: %s", buffer,
gst_flow_get_name (ret));
} else {
gst_buffer_unref (buffer);
GST_LOG_OBJECT (pad, "Dropped buffer %p: no otherpad", buffer);
}
return GST_FLOW_OK;
}
static GstFlowReturn
gst_proxy_sink_sink_chain_list (GstPad * pad, GstObject * parent,
GstBufferList * list)
{
GstProxySink *self = GST_PROXY_SINK (parent);
GstProxySrc *src;
GstFlowReturn ret = GST_FLOW_OK;
GST_LOG_OBJECT (pad, "Chaining buffer list %p", list);
src = g_weak_ref_get (&self->priv->proxysrc);
if (src) {
GstPad *srcpad;
srcpad = gst_proxy_src_get_internal_srcpad (src);
if (self->priv->pending_sticky_events) {
CopyStickyEventsData data = { srcpad, GST_FLOW_OK };
gst_pad_sticky_events_foreach (pad, copy_sticky_events, &data);
self->priv->pending_sticky_events = data.ret != GST_FLOW_OK;
}
ret = gst_pad_push_list (srcpad, list);
gst_object_unref (srcpad);
gst_object_unref (src);
GST_LOG_OBJECT (pad, "Chained buffer list %p: %s", list,
gst_flow_get_name (ret));
} else {
gst_buffer_list_unref (list);
GST_LOG_OBJECT (pad, "Dropped buffer list %p: no otherpad", list);
}
return GST_FLOW_OK;
}
/* Wrapper function for accessing private member
* This can also be retrieved with gst_element_get_static_pad, but that depends
* on the implementation of GstProxySink */
GstPad *
gst_proxy_sink_get_internal_sinkpad (GstProxySink * self)
{
g_return_val_if_fail (self, NULL);
return gst_object_ref (self->priv->sinkpad);
}
void
gst_proxy_sink_set_proxysrc (GstProxySink * self, GstProxySrc * src)
{
g_return_if_fail (self);
g_weak_ref_set (&self->priv->proxysrc, src);
}
/*
* Copyright (C) 2015 Centricular Ltd.
* Author: Sebastian Dröge <sebastian@centricular.com>
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_PROXY_SINK_H__
#define __GST_PROXY_SINK_H__
#include <gst/gst.h>
G_BEGIN_DECLS
#define GST_TYPE_PROXY_SINK (gst_proxy_sink_get_type())
#define GST_PROXY_SINK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_PROXY_SINK, GstProxySink))
#define GST_IS_PROXY_SINK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_PROXY_SINK))
#define GST_PROXY_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass) , GST_TYPE_PROXY_SINK, GstProxySinkClass))
#define GST_IS_PROXY_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass) , GST_TYPE_PROXY_SINK))
#define GST_PROXY_SINK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj) , GST_TYPE_PROXY_SINK, GstProxySinkClass))
typedef struct _GstProxySink GstProxySink;
typedef struct _GstProxySinkClass GstProxySinkClass;
typedef struct _GstProxySinkPrivate GstProxySinkPrivate;
struct _GstProxySink {
GstElement parent;
/* < private > */
GstProxySinkPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
};
struct _GstProxySinkClass {
GstElementClass parent_class;
};
GType gst_proxy_sink_get_type (void);
G_END_DECLS
#endif /* __GST_PROXY_SINK_H__ */
This diff is collapsed.
/*
* Copyright (C) 2015 Centricular Ltd.
* Author: Sebastian Dröge <sebastian@centricular.com>
* Author: Nirbheek Chauhan <nirbheek@centricular.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GST_PROXY_SRC_H__
#define __GST_PROXY_SRC_H__
#include <gst/gst.h>
G_BEGIN_DECLS
#define GST_TYPE_PROXY_SRC (gst_proxy_src_get_type())
#define GST_PROXY_SRC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GST_TYPE_PROXY_SRC, GstProxySrc))
#define GST_IS_PROXY_SRC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GST_TYPE_PROXY_SRC))
#define GST_PROXY_SRC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass) , GST_TYPE_PROXY_SRC, GstProxySrcClass))
#define GST_IS_PROXY_SRC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass) , GST_TYPE_PROXY_SRC))
#define GST_PROXY_SRC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj) , GST_TYPE_PROXY_SRC, GstProxySrcClass))
typedef struct _GstProxySrc GstProxySrc;
typedef struct _GstProxySrcClass GstProxySrcClass;
typedef struct _GstProxySrcPrivate GstProxySrcPrivate;
struct _GstProxySrc {
GstBin parent;
/* < private > */
GstProxySrcPrivate *priv;
gpointer _gst_reserved[GST_PADDING];
};
struct _GstProxySrcClass {
GstBinClass parent_class;
};
GType gst_proxy_src_get_type(void);
G_END_DECLS
#endif /* __GST_PROXY_SRC_H__ */
proxy_sources = [
'gstproxy.c',
'gstproxysink.c',
'gstproxysrc.c'
]
gstproxy = library('gstproxy',
proxy_sources,
c_args : gst_plugins_bad_args,
include_directories : [configinc],
dependencies : [gstbase_dep],
install : true,
install_dir : plugins_install_dir,
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment