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