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_sink_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_static_pad_template (gstelement_class, &srctemplate);
  99   gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
 100
 101   gst_element_class_set_static_metadata (gstelement_class, "Valve element",
 102       "Filter", "Drops buffers and events or lets them through",
 103       "Olivier Crete <olivier.crete@collabora.co.uk>");
 104 }
 105
 106 static void
 107 gst_valve_init (GstValve * valve)
 108 {
 109   valve->drop = FALSE;
 110   valve->discont = FALSE;
 111
 112   valve->srcpad = gst_pad_new_from_static_template (&srctemplate, "src");
 113   gst_pad_set_query_function (valve->srcpad,
 114       GST_DEBUG_FUNCPTR (gst_valve_query));
 115   GST_PAD_SET_PROXY_CAPS (valve->srcpad);
 116   gst_element_add_pad (GST_ELEMENT (valve), valve->srcpad);
 117
 118   valve->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 119   gst_pad_set_chain_function (valve->sinkpad,
 120       GST_DEBUG_FUNCPTR (gst_valve_chain));
 121   gst_pad_set_event_function (valve->sinkpad,
 122       GST_DEBUG_FUNCPTR (gst_valve_sink_event));
 123   gst_pad_set_query_function (valve->sinkpad,
 124       GST_DEBUG_FUNCPTR (gst_valve_query));
 125   GST_PAD_SET_PROXY_CAPS (valve->sinkpad);
 126   GST_PAD_SET_PROXY_ALLOCATION (valve->sinkpad);
 127   gst_element_add_pad (GST_ELEMENT (valve), valve->sinkpad);
 128 }
 129
 130
 131 static void
 132 gst_valve_set_property (GObject * object,
 133     guint prop_id, const GValue * value, GParamSpec * pspec)
 134 {
 135   GstValve *valve = GST_VALVE (object);
 136
 137   switch (prop_id) {
 138     case PROP_DROP:
 139       g_atomic_int_set (&valve->drop, g_value_get_boolean (value));
 140       gst_pad_push_event (valve->sinkpad, gst_event_new_reconfigure ());
 141       break;
 142     default:
 143       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 144       break;
 145   }
 146 }
 147
 148 static void
 149 gst_valve_get_property (GObject * object,
 150     guint prop_id, GValue * value, GParamSpec * pspec)
 151 {
 152   GstValve *valve = GST_VALVE (object);
 153
 154   switch (prop_id) {
 155     case PROP_DROP:
 156       g_value_set_boolean (value, g_atomic_int_get (&valve->drop));
 157       break;
 158     default:
 159       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 160       break;
 161   }
 162 }
 163
 164
 165 static gboolean
 166 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
 167 {
 168   GstValve *valve = user_data;
 169
 170   if (!gst_pad_push_event (valve->srcpad, gst_event_ref (*event)))
 171     valve->need_repush_sticky = TRUE;
 172
 173   return TRUE;
 174 }
 175
 176 static void
 177 gst_valve_repush_sticky (GstValve * valve)
 178 {
 179   valve->need_repush_sticky = FALSE;
 180   gst_pad_sticky_events_foreach (valve->sinkpad, forward_sticky_events, valve);
 181 }
 182
 183 static GstFlowReturn
 184 gst_valve_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 185 {
 186   GstValve *valve = GST_VALVE (parent);
 187   GstFlowReturn ret = GST_FLOW_OK;
 188
 189   if (g_atomic_int_get (&valve->drop)) {
 190     gst_buffer_unref (buffer);
 191     valve->discont = TRUE;
 192   } else {
 193     if (valve->discont) {
 194       buffer = gst_buffer_make_writable (buffer);
 195       GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
 196       valve->discont = FALSE;
 197     }
 198
 199     if (valve->need_repush_sticky)
 200       gst_valve_repush_sticky (valve);
 201
 202     ret = gst_pad_push (valve->srcpad, buffer);
 203   }
 204
 205
 206   /* Ignore errors if "drop" was changed while the thread was blocked
 207    * downwards
 208    */
 209   if (g_atomic_int_get (&valve->drop))
 210     ret = GST_FLOW_OK;
 211
 212   return ret;
 213 }
 214
 215
 216 static gboolean
 217 gst_valve_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 218 {
 219   GstValve *valve;
 220   gboolean is_sticky = GST_EVENT_IS_STICKY (event);
 221   gboolean ret = TRUE;
 222
 223   valve = GST_VALVE (parent);
 224
 225   if (g_atomic_int_get (&valve->drop)) {
 226     valve->need_repush_sticky |= is_sticky;
 227     gst_event_unref (event);
 228   } else {
 229     if (valve->need_repush_sticky)
 230       gst_valve_repush_sticky (valve);
 231     ret = gst_pad_event_default (pad, parent, event);
 232   }
 233
 234   /* Ignore errors if "drop" was changed while the thread was blocked
 235    * downwards.
 236    */
 237   if (g_atomic_int_get (&valve->drop)) {
 238     valve->need_repush_sticky |= is_sticky;
 239     ret = TRUE;
 240   }
 241
 242   return ret;
 243 }
 244
 245
 246
 247 static gboolean
 248 gst_valve_query (GstPad * pad, GstObject * parent, GstQuery * query)
 249 {
 250   GstValve *valve = GST_VALVE (parent);
 251
 252   if (GST_QUERY_IS_SERIALIZED (query) && g_atomic_int_get (&valve->drop))
 253     return FALSE;
 254
 255   return gst_pad_query_default (pad, parent, query);
 256 }