gst/debug/breakmydata.c

   1 /* GStreamer
   2  * Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 /**
  20  * SECTION:element-breakmydata
  21  *
  22  * This element modifies the contents of the buffer it is passed randomly
  23  * according to the parameters set.
  24  * It otherwise acts as an identity.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include "config.h"
  29 #endif
  30
  31 #include <gst/gst.h>
  32 #include <gst/base/gstbasetransform.h>
  33
  34 GST_DEBUG_CATEGORY_STATIC (gst_break_my_data_debug);
  35 #define GST_CAT_DEFAULT gst_break_my_data_debug
  36
  37 #define GST_TYPE_BREAK_MY_DATA \
  38   (gst_break_my_data_get_type())
  39 #define GST_BREAK_MY_DATA(obj) \
  40   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BREAK_MY_DATA,GstBreakMyData))
  41 #define GST_BREAK_MY_DATA_CLASS(klass) \
  42   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BREAK_MY_DATA,GstBreakMyDataClass))
  43 #define GST_IS_BREAK_MY_DATA(obj) \
  44   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BREAK_MY_DATA))
  45 #define GST_IS_BREAK_MY_DATA_CLASS(klass) \
  46   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BREAK_MY_DATA))
  47
  48 enum
  49 {
  50   ARG_0,
  51   ARG_SEED,
  52   ARG_SET_TO,
  53   ARG_SKIP,
  54   ARG_PROBABILITY
  55 };
  56
  57 typedef struct _GstBreakMyData GstBreakMyData;
  58 typedef struct _GstBreakMyDataClass GstBreakMyDataClass;
  59
  60 struct _GstBreakMyData
  61 {
  62   GstBaseTransform basetransform;
  63
  64   GRand *rand;
  65   guint skipped;
  66
  67   guint32 seed;
  68   gint set;
  69   guint skip;
  70   gdouble probability;
  71 };
  72
  73 struct _GstBreakMyDataClass
  74 {
  75   GstBaseTransformClass parent_class;
  76 };
  77
  78 static void gst_break_my_data_set_property (GObject * object,
  79     guint prop_id, const GValue * value, GParamSpec * pspec);
  80 static void gst_break_my_data_get_property (GObject * object,
  81     guint prop_id, GValue * value, GParamSpec * pspec);
  82
  83 static GstFlowReturn gst_break_my_data_transform_ip (GstBaseTransform * trans,
  84     GstBuffer * buf);
  85 static gboolean gst_break_my_data_stop (GstBaseTransform * trans);
  86 static gboolean gst_break_my_data_start (GstBaseTransform * trans);
  87
  88 static const GstElementDetails details = GST_ELEMENT_DETAILS ("Break my data",
  89     "Testing",
  90     "randomly change data in the stream",
  91     "Benjamin Otte <otte@gnome>");
  92
  93 GstStaticPadTemplate bmd_src_template = GST_STATIC_PAD_TEMPLATE ("src",
  94     GST_PAD_SRC,
  95     GST_PAD_ALWAYS,
  96     GST_STATIC_CAPS_ANY);
  97
  98 GstStaticPadTemplate bmd_sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  99     GST_PAD_SINK,
 100     GST_PAD_ALWAYS,
 101     GST_STATIC_CAPS_ANY);
 102
 103
 104 #define DEBUG_INIT(bla) \
 105   GST_DEBUG_CATEGORY_INIT (gst_break_my_data_debug, "breakmydata", 0, \
 106       "debugging category for breakmydata element");
 107
 108 GST_BOILERPLATE_FULL (GstBreakMyData, gst_break_my_data, GstBaseTransform,
 109     GST_TYPE_BASE_TRANSFORM, DEBUG_INIT);
 110
 111
 112 static void
 113 gst_break_my_data_base_init (gpointer g_class)
 114 {
 115   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 116
 117   gst_element_class_add_pad_template (gstelement_class,
 118       gst_static_pad_template_get (&bmd_sink_template));
 119   gst_element_class_add_pad_template (gstelement_class,
 120       gst_static_pad_template_get (&bmd_src_template));
 121
 122   gst_element_class_set_details (gstelement_class, &details);
 123 }
 124
 125 static void
 126 gst_break_my_data_class_init (GstBreakMyDataClass * klass)
 127 {
 128   GstBaseTransformClass *gstbasetrans_class;
 129   GObjectClass *gobject_class;
 130
 131   gobject_class = G_OBJECT_CLASS (klass);
 132   gstbasetrans_class = GST_BASE_TRANSFORM_CLASS (klass);
 133
 134   gobject_class->set_property =
 135       GST_DEBUG_FUNCPTR (gst_break_my_data_set_property);
 136   gobject_class->get_property =
 137       GST_DEBUG_FUNCPTR (gst_break_my_data_get_property);
 138
 139   g_object_class_install_property (gobject_class, ARG_SEED,
 140       g_param_spec_uint ("seed", "seed",
 141           "seed for randomness (initialized when going from READY to PAUSED)",
 142           0, G_MAXUINT32, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 143   g_object_class_install_property (gobject_class, ARG_SET_TO,
 144       g_param_spec_int ("set-to", "set-to",
 145           "set changed bytes to this value (-1 means random value",
 146           -1, G_MAXUINT8, -1, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 147   g_object_class_install_property (gobject_class, ARG_SKIP,
 148       g_param_spec_uint ("skip", "skip",
 149           "amount of bytes skipped at the beginning of stream",
 150           0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 151   g_object_class_install_property (gobject_class, ARG_PROBABILITY,
 152       g_param_spec_double ("probability", "probability",
 153           "probability for each byte in the buffer to be changed", 0.0, 1.0,
 154           0.0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 155
 156   gstbasetrans_class->transform_ip =
 157       GST_DEBUG_FUNCPTR (gst_break_my_data_transform_ip);
 158   gstbasetrans_class->start = GST_DEBUG_FUNCPTR (gst_break_my_data_start);
 159   gstbasetrans_class->stop = GST_DEBUG_FUNCPTR (gst_break_my_data_stop);
 160 }
 161
 162 static void
 163 gst_break_my_data_init (GstBreakMyData * bmd, GstBreakMyDataClass * g_class)
 164 {
 165   gst_base_transform_set_in_place (GST_BASE_TRANSFORM (bmd), TRUE);
 166   gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (bmd), TRUE);
 167 }
 168
 169 static void
 170 gst_break_my_data_set_property (GObject * object, guint prop_id,
 171     const GValue * value, GParamSpec * pspec)
 172 {
 173   GstBreakMyData *bmd = GST_BREAK_MY_DATA (object);
 174
 175   GST_OBJECT_LOCK (bmd);
 176
 177   switch (prop_id) {
 178     case ARG_SEED:
 179       bmd->seed = g_value_get_uint (value);
 180       break;
 181     case ARG_SET_TO:
 182       bmd->set = g_value_get_int (value);
 183       break;
 184     case ARG_SKIP:
 185       bmd->skip = g_value_get_uint (value);
 186       break;
 187     case ARG_PROBABILITY:
 188       bmd->probability = g_value_get_double (value);
 189       break;
 190     default:
 191       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 192       break;
 193   }
 194
 195   GST_OBJECT_UNLOCK (bmd);
 196 }
 197
 198 static void
 199 gst_break_my_data_get_property (GObject * object, guint prop_id, GValue * value,
 200     GParamSpec * pspec)
 201 {
 202   GstBreakMyData *bmd = GST_BREAK_MY_DATA (object);
 203
 204   GST_OBJECT_LOCK (bmd);
 205
 206   switch (prop_id) {
 207     case ARG_SEED:
 208       g_value_set_uint (value, bmd->seed);
 209       break;
 210     case ARG_SET_TO:
 211       g_value_set_int (value, bmd->set);
 212       break;
 213     case ARG_SKIP:
 214       g_value_set_uint (value, bmd->skip);
 215       break;
 216     case ARG_PROBABILITY:
 217       g_value_set_double (value, bmd->probability);
 218       break;
 219     default:
 220       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 221       break;
 222   }
 223
 224   GST_OBJECT_UNLOCK (bmd);
 225 }
 226
 227 static GstFlowReturn
 228 gst_break_my_data_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
 229 {
 230   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 231   guint i, size;
 232
 233   g_return_val_if_fail (gst_buffer_is_writable (buf), GST_FLOW_ERROR);
 234
 235   GST_OBJECT_LOCK (bmd);
 236
 237   if (bmd->skipped < bmd->skip) {
 238     i = bmd->skip - bmd->skipped;
 239   } else {
 240     i = 0;
 241   }
 242
 243   size = GST_BUFFER_SIZE (buf);
 244
 245   GST_LOG_OBJECT (bmd,
 246       "got buffer %p (size %u, timestamp %" G_GUINT64_FORMAT ", offset %"
 247       G_GUINT64_FORMAT "", buf, size, GST_BUFFER_TIMESTAMP (buf),
 248       GST_BUFFER_OFFSET (buf));
 249
 250   for (; i < size; i++) {
 251     if (g_rand_double_range (bmd->rand, 0, 1.0) <= bmd->probability) {
 252       guint8 new;
 253
 254       if (bmd->set < 0) {
 255         new = g_rand_int_range (bmd->rand, 0, 256);
 256       } else {
 257         new = bmd->set;
 258       }
 259       GST_INFO_OBJECT (bmd, "changing byte %u from 0x%02X to 0x%02X", i,
 260           (guint) GST_READ_UINT8 (GST_BUFFER_DATA (buf) + i),
 261           (guint) ((guint8) new));
 262       GST_BUFFER_DATA (buf)[i] = new;
 263     }
 264   }
 265   /* don't overflow */
 266   bmd->skipped += MIN (G_MAXUINT - bmd->skipped, GST_BUFFER_SIZE (buf));
 267
 268   GST_OBJECT_UNLOCK (bmd);
 269
 270   return GST_FLOW_OK;
 271 }
 272
 273 static gboolean
 274 gst_break_my_data_start (GstBaseTransform * trans)
 275 {
 276   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 277
 278   GST_OBJECT_LOCK (bmd);
 279   bmd->rand = g_rand_new_with_seed (bmd->seed);
 280   bmd->skipped = 0;
 281   GST_OBJECT_UNLOCK (bmd);
 282
 283   return TRUE;
 284 }
 285
 286 static gboolean
 287 gst_break_my_data_stop (GstBaseTransform * trans)
 288 {
 289   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 290
 291   GST_OBJECT_LOCK (bmd);
 292   g_rand_free (bmd->rand);
 293   bmd->rand = NULL;
 294   GST_OBJECT_UNLOCK (bmd);
 295
 296   return TRUE;
 297 }