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 GST_BOILERPLATE (GstBreakMyData, gst_break_my_data, GstBaseTransform,
 104     GST_TYPE_BASE_TRANSFORM);
 105
 106 static void
 107 gst_break_my_data_base_init (gpointer g_class)
 108 {
 109   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 110
 111   gst_element_class_add_pad_template (gstelement_class,
 112       gst_static_pad_template_get (&bmd_sink_template));
 113   gst_element_class_add_pad_template (gstelement_class,
 114       gst_static_pad_template_get (&bmd_src_template));
 115
 116   gst_element_class_set_details (gstelement_class, &details);
 117 }
 118
 119 static void
 120 gst_break_my_data_class_init (GstBreakMyDataClass * klass)
 121 {
 122   GstBaseTransformClass *gstbasetrans_class;
 123   GObjectClass *gobject_class;
 124
 125   gobject_class = G_OBJECT_CLASS (klass);
 126   gstbasetrans_class = GST_BASE_TRANSFORM_CLASS (klass);
 127
 128   gobject_class->set_property =
 129       GST_DEBUG_FUNCPTR (gst_break_my_data_set_property);
 130   gobject_class->get_property =
 131       GST_DEBUG_FUNCPTR (gst_break_my_data_get_property);
 132
 133   g_object_class_install_property (gobject_class, ARG_SEED,
 134       g_param_spec_uint ("seed", "seed",
 135           "seed for randomness (initialized when going from READY to PAUSED)",
 136           0, G_MAXUINT32, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 137   g_object_class_install_property (gobject_class, ARG_SET_TO,
 138       g_param_spec_int ("set-to", "set-to",
 139           "set changed bytes to this value (-1 means random value",
 140           -1, G_MAXUINT8, -1, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 141   g_object_class_install_property (gobject_class, ARG_SKIP,
 142       g_param_spec_uint ("skip", "skip",
 143           "amount of bytes skipped at the beginning of stream",
 144           0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 145   g_object_class_install_property (gobject_class, ARG_PROBABILITY,
 146       g_param_spec_double ("probability", "probability",
 147           "probability for each byte in the buffer to be changed", 0.0, 1.0,
 148           0.0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
 149
 150   gstbasetrans_class->transform_ip =
 151       GST_DEBUG_FUNCPTR (gst_break_my_data_transform_ip);
 152   gstbasetrans_class->start = GST_DEBUG_FUNCPTR (gst_break_my_data_start);
 153   gstbasetrans_class->stop = GST_DEBUG_FUNCPTR (gst_break_my_data_stop);
 154 }
 155
 156 static void
 157 gst_break_my_data_init (GstBreakMyData * bmd, GstBreakMyDataClass * g_class)
 158 {
 159   gst_base_transform_set_in_place (GST_BASE_TRANSFORM (bmd), TRUE);
 160   gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (bmd), TRUE);
 161 }
 162
 163 static void
 164 gst_break_my_data_set_property (GObject * object, guint prop_id,
 165     const GValue * value, GParamSpec * pspec)
 166 {
 167   GstBreakMyData *bmd = GST_BREAK_MY_DATA (object);
 168
 169   GST_OBJECT_LOCK (bmd);
 170
 171   switch (prop_id) {
 172     case ARG_SEED:
 173       bmd->seed = g_value_get_uint (value);
 174       break;
 175     case ARG_SET_TO:
 176       bmd->set = g_value_get_int (value);
 177       break;
 178     case ARG_SKIP:
 179       bmd->skip = g_value_get_uint (value);
 180       break;
 181     case ARG_PROBABILITY:
 182       bmd->probability = g_value_get_double (value);
 183       break;
 184     default:
 185       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 186       break;
 187   }
 188
 189   GST_OBJECT_UNLOCK (bmd);
 190 }
 191
 192 static void
 193 gst_break_my_data_get_property (GObject * object, guint prop_id, GValue * value,
 194     GParamSpec * pspec)
 195 {
 196   GstBreakMyData *bmd = GST_BREAK_MY_DATA (object);
 197
 198   GST_OBJECT_LOCK (bmd);
 199
 200   switch (prop_id) {
 201     case ARG_SEED:
 202       g_value_set_uint (value, bmd->seed);
 203       break;
 204     case ARG_SET_TO:
 205       g_value_set_int (value, bmd->set);
 206       break;
 207     case ARG_SKIP:
 208       g_value_set_uint (value, bmd->skip);
 209       break;
 210     case ARG_PROBABILITY:
 211       g_value_set_double (value, bmd->probability);
 212       break;
 213     default:
 214       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 215       break;
 216   }
 217
 218   GST_OBJECT_UNLOCK (bmd);
 219 }
 220
 221 static GstFlowReturn
 222 gst_break_my_data_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
 223 {
 224   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 225   guint i, size;
 226
 227   g_return_val_if_fail (gst_buffer_is_writable (buf), GST_FLOW_ERROR);
 228
 229   GST_OBJECT_LOCK (bmd);
 230
 231   if (bmd->skipped < bmd->skip) {
 232     i = bmd->skip - bmd->skipped;
 233   } else {
 234     i = 0;
 235   }
 236
 237   size = GST_BUFFER_SIZE (buf);
 238
 239   GST_LOG_OBJECT (bmd,
 240       "got buffer %p (size %u, timestamp %" G_GUINT64_FORMAT ", offset %"
 241       G_GUINT64_FORMAT "", buf, size, GST_BUFFER_TIMESTAMP (buf),
 242       GST_BUFFER_OFFSET (buf));
 243
 244   for (; i < size; i++) {
 245     if (g_rand_double_range (bmd->rand, 0, 1.0) <= bmd->probability) {
 246       guint8 new;
 247
 248       if (bmd->set < 0) {
 249         new = g_rand_int_range (bmd->rand, 0, 256);
 250       } else {
 251         new = bmd->set;
 252       }
 253       GST_INFO_OBJECT (bmd, "changing byte %u from 0x%02X to 0x%02X", i,
 254           (guint) GST_READ_UINT8 (GST_BUFFER_DATA (buf) + i),
 255           (guint) ((guint8) new));
 256       GST_BUFFER_DATA (buf)[i] = new;
 257     }
 258   }
 259   /* don't overflow */
 260   bmd->skipped += MIN (G_MAXUINT - bmd->skipped, GST_BUFFER_SIZE (buf));
 261
 262   GST_OBJECT_UNLOCK (bmd);
 263
 264   return GST_FLOW_OK;
 265 }
 266
 267 static gboolean
 268 gst_break_my_data_start (GstBaseTransform * trans)
 269 {
 270   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 271
 272   GST_OBJECT_LOCK (bmd);
 273   bmd->rand = g_rand_new_with_seed (bmd->seed);
 274   bmd->skipped = 0;
 275   GST_OBJECT_UNLOCK (bmd);
 276
 277   return TRUE;
 278 }
 279
 280 static gboolean
 281 gst_break_my_data_stop (GstBaseTransform * trans)
 282 {
 283   GstBreakMyData *bmd = GST_BREAK_MY_DATA (trans);
 284
 285   GST_OBJECT_LOCK (bmd);
 286   g_rand_free (bmd->rand);
 287   bmd->rand = NULL;
 288   GST_OBJECT_UNLOCK (bmd);
 289
 290   return TRUE;
 291 }
 292
 293 gboolean
 294 gst_break_my_data_plugin_init (GstPlugin * plugin)
 295 {
 296   if (!gst_element_register (plugin, "breakmydata", GST_RANK_NONE,
 297           GST_TYPE_BREAK_MY_DATA))
 298     return FALSE;
 299
 300   GST_DEBUG_CATEGORY_INIT (gst_break_my_data_debug, "breakmydata", 0,
 301       "debugging category for breakmydata element");
 302
 303   return TRUE;
 304 }