plugins/elements/gstvalve.c

   1 /* GStreamer valve element
   2  *  Copyright 2007-2009 Collabora Ltd
   3  *   @author: Olivier Crete <olivier.crete@collabora.co.uk>
   4  *  Copyright 2007-2009 Nokia Corporation
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  *
  21  */
  22
  23 /**
  24  * SECTION:element-valve
  25  * @title: valve
  26  *
  27  * The valve is a simple element that drops buffers when the #GstValve:drop
  28  * property is set to %TRUE and lets then through otherwise.
  29  *
  30  * Any downstream error received while the #GstValve:drop property is %TRUE
  31  * is ignored. So downstream element can be set to  %GST_STATE_NULL and removed,
  32  * without using pad blocking.
  33  */
  34
  35 #ifdef HAVE_CONFIG_H
  36 #include "config.h"
  37 #endif
  38
  39 #include "gstvalve.h"
  40
  41 #include <string.h>
  42
  43 GST_DEBUG_CATEGORY_STATIC (valve_debug);
  44 #define GST_CAT_DEFAULT (valve_debug)
  45
  46 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  47     GST_PAD_SINK,
  48     GST_PAD_ALWAYS,
  49     GST_STATIC_CAPS_ANY);
  50
  51 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  52     GST_PAD_SRC,
  53     GST_PAD_ALWAYS,
  54     GST_STATIC_CAPS_ANY);
  55
  56 enum
  57 {
  58   PROP_0,
  59   PROP_DROP
  60 };
  61
  62 #define DEFAULT_DROP FALSE
  63
  64 static void gst_valve_set_property (GObject * object,
  65     guint prop_id, const GValue * value, GParamSpec * pspec);
  66 static void gst_valve_get_property (GObject * object,
  67     guint prop_id, GValue * value, GParamSpec * pspec);
  68
  69 static GstFlowReturn gst_valve_chain (GstPad * pad, GstObject * parent,
  70     GstBuffer * buffer);
  71 static gboolean gst_valve_sink_event (GstPad * pad, GstObject * parent,
  72     GstEvent * event);
  73 static gboolean gst_valve_query (GstPad * pad, GstObject * parent,
  74     GstQuery * query);
  75
  76 #define _do_init \
  77   GST_DEBUG_CATEGORY_INIT (valve_debug, "valve", 0, "Valve");
  78 #define gst_valve_parent_class parent_class
  79 G_DEFINE_TYPE_WITH_CODE (GstValve, gst_valve, GST_TYPE_ELEMENT, _do_init);
  80
  81 static void
  82 gst_valve_class_init (GstValveClass * klass)
  83 {
  84   GObjectClass *gobject_class;
  85   GstElementClass *gstelement_class;
  86
  87   gobject_class = (GObjectClass *) klass;
  88   gstelement_class = (GstElementClass *) (klass);
  89
  90   gobject_class->set_property = gst_valve_set_property;
  91   gobject_class->get_property = gst_valve_get_property;
  92
  93   g_object_class_install_property (gobject_class, PROP_DROP,
  94       g_param_spec_boolean ("drop", "Drop buffers and events",
  95           "Whether to drop buffers and events or let them through",
  96           DEFAULT_DROP, G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
  97           G_PARAM_STATIC_STRINGS));
  98
  99   gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);
 100   gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
 101
 102   gst_element_class_set_static_metadata (gstelement_class, "Valve element",
 103       "Filter", "Drops buffers and events or lets them through",
 104       "Olivier Crete <olivier.crete@collabora.co.uk>");
 105 }
 106
 107 static void
 108 gst_valve_init (GstValve * valve)
 109 {
 110   valve->drop = FALSE;
 111   valve->discont = FALSE;
 112
 113   valve->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
 114   gst_pad_set_query_function (valve->srcpad,
 115       GST_DEBUG_FUNCPTR (gst_valve_query));
 116   GST_PAD_SET_PROXY_CAPS (valve->srcpad);
 117   gst_element_add_pad (GST_ELEMENT (valve), valve->srcpad);
 118
 119   valve->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 120   gst_pad_set_chain_function (valve->sinkpad,
 121       GST_DEBUG_FUNCPTR (gst_valve_chain));
 122   gst_pad_set_event_function (valve->sinkpad,
 123       GST_DEBUG_FUNCPTR (gst_valve_sink_event));
 124   gst_pad_set_query_function (valve->sinkpad,
 125       GST_DEBUG_FUNCPTR (gst_valve_query));
 126   GST_PAD_SET_PROXY_CAPS (valve->sinkpad);
 127   GST_PAD_SET_PROXY_ALLOCATION (valve->sinkpad);
 128   gst_element_add_pad (GST_ELEMENT (valve), valve->sinkpad);
 129 }
 130
 131
 132 static void
 133 gst_valve_set_property (GObject * object,
 134     guint prop_id, const GValue * value, GParamSpec * pspec)
 135 {
 136   GstValve *valve = GST_VALVE (object);
 137
 138   switch (prop_id) {
 139     case PROP_DROP:
 140       g_atomic_int_set (&valve->drop, g_value_get_boolean (value));
 141       gst_pad_push_event (valve->sinkpad, gst_event_new_reconfigure ());
 142       break;
 143     default:
 144       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 145       break;
 146   }
 147 }
 148
 149 static void
 150 gst_valve_get_property (GObject * object,
 151     guint prop_id, GValue * value, GParamSpec * pspec)
 152 {
 153   GstValve *valve = GST_VALVE (object);
 154
 155   switch (prop_id) {
 156     case PROP_DROP:
 157       g_value_set_boolean (value, g_atomic_int_get (&valve->drop));
 158       break;
 159     default:
 160       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 161       break;
 162   }
 163 }
 164
 165
 166 static gboolean
 167 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
 168 {
 169   GstValve *valve = user_data;
 170
 171   if (!gst_pad_push_event (valve->srcpad, gst_event_ref (*event)))
 172     valve->need_repush_sticky = TRUE;
 173
 174   return TRUE;
 175 }
 176
 177 static void
 178 gst_valve_repush_sticky (GstValve * valve)
 179 {
 180   valve->need_repush_sticky = FALSE;
 181   gst_pad_sticky_events_foreach (valve->sinkpad, forward_sticky_events, valve);
 182 }
 183
 184 static GstFlowReturn
 185 gst_valve_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 186 {
 187   GstValve *valve = GST_VALVE (parent);
 188   GstFlowReturn ret = GST_FLOW_OK;
 189
 190   if (g_atomic_int_get (&valve->drop)) {
 191     gst_buffer_unref (buffer);
 192     valve->discont = TRUE;
 193   } else {
 194     if (valve->discont) {
 195       buffer = gst_buffer_make_writable (buffer);
 196       GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
 197       valve->discont = FALSE;
 198     }
 199
 200     if (valve->need_repush_sticky)
 201       gst_valve_repush_sticky (valve);
 202
 203     ret = gst_pad_push (valve->srcpad, buffer);
 204   }
 205
 206
 207   /* Ignore errors if "drop" was changed while the thread was blocked
 208    * downwards
 209    */
 210   if (g_atomic_int_get (&valve->drop))
 211     ret = GST_FLOW_OK;
 212
 213   return ret;
 214 }
 215
 216
 217 static gboolean
 218 gst_valve_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 219 {
 220   GstValve *valve;
 221   gboolean is_sticky = GST_EVENT_IS_STICKY (event);
 222   gboolean ret = TRUE;
 223
 224   valve = GST_VALVE (parent);
 225
 226   if (g_atomic_int_get (&valve->drop)) {
 227     valve->need_repush_sticky |= is_sticky;
 228     gst_event_unref (event);
 229   } else {
 230     if (valve->need_repush_sticky)
 231       gst_valve_repush_sticky (valve);
 232     ret = gst_pad_event_default (pad, parent, event);
 233   }
 234
 235   /* Ignore errors if "drop" was changed while the thread was blocked
 236    * downwards.
 237    */
 238   if (g_atomic_int_get (&valve->drop)) {
 239     valve->need_repush_sticky |= is_sticky;
 240     ret = TRUE;
 241   }
 242
 243   return ret;
 244 }
 245
 246
 247
 248 static gboolean
 249 gst_valve_query (GstPad * pad, GstObject * parent, GstQuery * query)
 250 {
 251   GstValve *valve = GST_VALVE (parent);
 252
 253   if (GST_QUERY_IS_SERIALIZED (query) && g_atomic_int_get (&valve->drop))
 254     return FALSE;
 255
 256   return gst_pad_query_default (pad, parent, query);
 257 }