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  *
  26  * The valve is a simple element that drops buffers when the #GstValve:drop
  27  * property is set to %TRUE and lets then through otherwise.
  28  *
  29  * Any downstream error received while the #GstValve:drop property is %FALSE
  30  * is ignored. So downstream element can be set to  %GST_STATE_NULL and removed,
  31  * without using pad blocking.
  32  *
  33  * This element was previously part of gst-plugins-farsight, and then
  34  * gst-plugins-bad.
  35  *
  36  * Documentation last reviewed on 2010-12-30 (0.10.31)
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include "config.h"
  41 #endif
  42
  43 #include "gstvalve.h"
  44
  45 #include <string.h>
  46
  47 GST_DEBUG_CATEGORY_STATIC (valve_debug);
  48 #define GST_CAT_DEFAULT (valve_debug)
  49
  50 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  51     GST_PAD_SINK,
  52     GST_PAD_ALWAYS,
  53     GST_STATIC_CAPS_ANY);
  54
  55 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  56     GST_PAD_SRC,
  57     GST_PAD_ALWAYS,
  58     GST_STATIC_CAPS_ANY);
  59
  60 enum
  61 {
  62   PROP_0,
  63   PROP_DROP
  64 };
  65
  66 #define DEFAULT_DROP FALSE
  67
  68 static void gst_valve_set_property (GObject * object,
  69     guint prop_id, const GValue * value, GParamSpec * pspec);
  70 static void gst_valve_get_property (GObject * object,
  71     guint prop_id, GValue * value, GParamSpec * pspec);
  72
  73 static GstFlowReturn gst_valve_chain (GstPad * pad, GstObject * parent,
  74     GstBuffer * buffer);
  75 static gboolean gst_valve_event (GstPad * pad, GstObject * parent,
  76     GstEvent * event);
  77 static gboolean gst_valve_query (GstPad * pad, GstObject * parent,
  78     GstQuery * query);
  79
  80 #define _do_init \
  81   GST_DEBUG_CATEGORY_INIT (valve_debug, "valve", 0, "Valve");
  82 #define gst_valve_parent_class parent_class
  83 G_DEFINE_TYPE_WITH_CODE (GstValve, gst_valve, GST_TYPE_ELEMENT, _do_init);
  84
  85 static void
  86 gst_valve_class_init (GstValveClass * klass)
  87 {
  88   GObjectClass *gobject_class;
  89   GstElementClass *gstelement_class;
  90
  91   gobject_class = (GObjectClass *) klass;
  92   gstelement_class = (GstElementClass *) (klass);
  93
  94   gobject_class->set_property = gst_valve_set_property;
  95   gobject_class->get_property = gst_valve_get_property;
  96
  97   g_object_class_install_property (gobject_class, PROP_DROP,
  98       g_param_spec_boolean ("drop", "Drop buffers and events",
  99           "Whether to drop buffers and events or let them through",
 100           DEFAULT_DROP, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 101
 102   gst_element_class_add_pad_template (gstelement_class,
 103       gst_static_pad_template_get (&srctemplate));
 104   gst_element_class_add_pad_template (gstelement_class,
 105       gst_static_pad_template_get (&sinktemplate));
 106
 107   gst_element_class_set_static_metadata (gstelement_class, "Valve element",
 108       "Filter", "Drops buffers and events or lets them through",
 109       "Olivier Crete <olivier.crete@collabora.co.uk>");
 110 }
 111
 112 static void
 113 gst_valve_init (GstValve * valve)
 114 {
 115   valve->drop = FALSE;
 116   valve->discont = FALSE;
 117
 118   valve->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
 119   gst_pad_set_event_function (valve->srcpad,
 120       GST_DEBUG_FUNCPTR (gst_valve_event));
 121   gst_pad_set_query_function (valve->srcpad,
 122       GST_DEBUG_FUNCPTR (gst_valve_query));
 123   GST_PAD_SET_PROXY_CAPS (valve->srcpad);
 124   gst_element_add_pad (GST_ELEMENT (valve), valve->srcpad);
 125
 126   valve->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 127   gst_pad_set_chain_function (valve->sinkpad,
 128       GST_DEBUG_FUNCPTR (gst_valve_chain));
 129   gst_pad_set_event_function (valve->sinkpad,
 130       GST_DEBUG_FUNCPTR (gst_valve_event));
 131   gst_pad_set_query_function (valve->sinkpad,
 132       GST_DEBUG_FUNCPTR (gst_valve_query));
 133   GST_PAD_SET_PROXY_CAPS (valve->sinkpad);
 134   GST_PAD_SET_PROXY_ALLOCATION (valve->sinkpad);
 135   gst_element_add_pad (GST_ELEMENT (valve), valve->sinkpad);
 136 }
 137
 138
 139 static void
 140 gst_valve_set_property (GObject * object,
 141     guint prop_id, const GValue * value, GParamSpec * pspec)
 142 {
 143   GstValve *valve = GST_VALVE (object);
 144
 145   switch (prop_id) {
 146     case PROP_DROP:
 147       g_atomic_int_set (&valve->drop, g_value_get_boolean (value));
 148       gst_pad_push_event (valve->sinkpad, gst_event_new_reconfigure ());
 149       break;
 150     default:
 151       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 152       break;
 153   }
 154 }
 155
 156 static void
 157 gst_valve_get_property (GObject * object,
 158     guint prop_id, GValue * value, GParamSpec * pspec)
 159 {
 160   GstValve *valve = GST_VALVE (object);
 161
 162   switch (prop_id) {
 163     case PROP_DROP:
 164       g_value_set_boolean (value, g_atomic_int_get (&valve->drop));
 165       break;
 166     default:
 167       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 168       break;
 169   }
 170 }
 171
 172
 173 static gboolean
 174 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
 175 {
 176   GstValve *valve = user_data;
 177
 178   if (!gst_pad_push_event (valve->srcpad, gst_event_ref (*event)))
 179     valve->need_repush_sticky = TRUE;
 180
 181   return TRUE;
 182 }
 183
 184 static void
 185 gst_valve_repush_sticky (GstValve * valve)
 186 {
 187   valve->need_repush_sticky = FALSE;
 188   gst_pad_sticky_events_foreach (valve->sinkpad, forward_sticky_events, valve);
 189 }
 190
 191 static GstFlowReturn
 192 gst_valve_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 193 {
 194   GstValve *valve = GST_VALVE (parent);
 195   GstFlowReturn ret = GST_FLOW_OK;
 196
 197   if (g_atomic_int_get (&valve->drop)) {
 198     gst_buffer_unref (buffer);
 199     valve->discont = TRUE;
 200   } else {
 201     if (valve->discont) {
 202       buffer = gst_buffer_make_writable (buffer);
 203       GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
 204       valve->discont = FALSE;
 205     }
 206
 207     if (valve->need_repush_sticky)
 208       gst_valve_repush_sticky (valve);
 209
 210     ret = gst_pad_push (valve->srcpad, buffer);
 211   }
 212
 213
 214   /* Ignore errors if "drop" was changed while the thread was blocked
 215    * downwards
 216    */
 217   if (g_atomic_int_get (&valve->drop))
 218     ret = GST_FLOW_OK;
 219
 220   return ret;
 221 }
 222
 223
 224 static gboolean
 225 gst_valve_event (GstPad * pad, GstObject * parent, GstEvent * event)
 226 {
 227   GstValve *valve;
 228   gboolean is_sticky = GST_EVENT_IS_STICKY (event);
 229   gboolean ret = TRUE;
 230
 231   valve = GST_VALVE (parent);
 232
 233   if (g_atomic_int_get (&valve->drop)) {
 234     valve->need_repush_sticky |= is_sticky;
 235     gst_event_unref (event);
 236   } else {
 237     if (valve->need_repush_sticky)
 238       gst_valve_repush_sticky (valve);
 239     ret = gst_pad_event_default (pad, parent, event);
 240   }
 241
 242   /* Ignore errors if "drop" was changed while the thread was blocked
 243    * downwards.
 244    */
 245   if (g_atomic_int_get (&valve->drop)) {
 246     valve->need_repush_sticky |= is_sticky;
 247     ret = TRUE;
 248   }
 249
 250   return ret;
 251 }
 252
 253
 254
 255 static gboolean
 256 gst_valve_query (GstPad * pad, GstObject * parent, GstQuery * query)
 257 {
 258   GstValve *valve = GST_VALVE (parent);
 259
 260   if (g_atomic_int_get (&valve->drop))
 261     return FALSE;
 262
 263   return gst_pad_query_default (pad, parent, query);
 264 }