plugins/elements/gstfakesink.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2005 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstfakesink.c:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22 /**
  23  * SECTION:element-fakesink
  24  * @short_description: black hole for data
  25  * @see_also: #GstFakeSrc
  26  *
  27  * Dummy sink that swallows everything.
  28  */
  29
  30 #ifdef HAVE_CONFIG_H
  31 #  include "config.h"
  32 #endif
  33
  34 #include "gstfakesink.h"
  35 #include <gst/gstmarshal.h>
  36
  37 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  38     GST_PAD_SINK,
  39     GST_PAD_ALWAYS,
  40     GST_STATIC_CAPS_ANY);
  41
  42 GST_DEBUG_CATEGORY_STATIC (gst_fake_sink_debug);
  43 #define GST_CAT_DEFAULT gst_fake_sink_debug
  44
  45 static const GstElementDetails gst_fake_sink_details =
  46 GST_ELEMENT_DETAILS ("Fake Sink",
  47     "Sink",
  48     "Black hole for data",
  49     "Erik Walthinsen <omega@cse.ogi.edu>, "
  50     "Wim Taymans <wim@fluendo.com>, "
  51     "Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com>");
  52
  53
  54 /* FakeSink signals and args */
  55 enum
  56 {
  57   /* FILL ME */
  58   SIGNAL_HANDOFF,
  59   LAST_SIGNAL
  60 };
  61
  62 #define DEFAULT_SYNC FALSE
  63
  64 #define DEFAULT_STATE_ERROR FAKE_SINK_STATE_ERROR_NONE
  65 #define DEFAULT_SILENT FALSE
  66 #define DEFAULT_DUMP FALSE
  67 #define DEFAULT_SIGNAL_HANDOFFS FALSE
  68 #define DEFAULT_LAST_MESSAGE NULL
  69 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
  70 #define DEFAULT_CAN_ACTIVATE_PULL FALSE
  71
  72 enum
  73 {
  74   PROP_0,
  75   PROP_STATE_ERROR,
  76   PROP_SILENT,
  77   PROP_DUMP,
  78   PROP_SIGNAL_HANDOFFS,
  79   PROP_LAST_MESSAGE,
  80   PROP_CAN_ACTIVATE_PUSH,
  81   PROP_CAN_ACTIVATE_PULL
  82 };
  83
  84 #define GST_TYPE_FAKE_SINK_STATE_ERROR (gst_fake_sink_state_error_get_type())
  85 static GType
  86 gst_fake_sink_state_error_get_type (void)
  87 {
  88   static GType fakesink_state_error_type = 0;
  89   static GEnumValue fakesink_state_error[] = {
  90     {FAKE_SINK_STATE_ERROR_NONE, "No state change errors", "none"},
  91     {FAKE_SINK_STATE_ERROR_NULL_READY,
  92         "Fail state change from NULL to READY", "null-to-ready"},
  93     {FAKE_SINK_STATE_ERROR_READY_PAUSED,
  94         "Fail state change from READY to PAUSED", "ready-to-paused"},
  95     {FAKE_SINK_STATE_ERROR_PAUSED_PLAYING,
  96         "Fail state change from PAUSED to PLAYING", "paused-to-playing"},
  97     {FAKE_SINK_STATE_ERROR_PLAYING_PAUSED,
  98         "Fail state change from PLAYING to PAUSED", "playing-to-paused"},
  99     {FAKE_SINK_STATE_ERROR_PAUSED_READY,
 100         "Fail state change from PAUSED to READY", "paused-to-ready"},
 101     {FAKE_SINK_STATE_ERROR_READY_NULL,
 102         "Fail state change from READY to NULL", "ready-to-null"},
 103     {0, NULL, NULL},
 104   };
 105
 106   if (!fakesink_state_error_type) {
 107     fakesink_state_error_type =
 108         g_enum_register_static ("GstFakeSinkStateError", fakesink_state_error);
 109   }
 110   return fakesink_state_error_type;
 111 }
 112
 113 #define _do_init(bla) \
 114     GST_DEBUG_CATEGORY_INIT (gst_fake_sink_debug, "fakesink", 0, "fakesink element");
 115
 116 GST_BOILERPLATE_FULL (GstFakeSink, gst_fake_sink, GstBaseSink,
 117     GST_TYPE_BASE_SINK, _do_init);
 118
 119 static void gst_fake_sink_set_property (GObject * object, guint prop_id,
 120     const GValue * value, GParamSpec * pspec);
 121 static void gst_fake_sink_get_property (GObject * object, guint prop_id,
 122     GValue * value, GParamSpec * pspec);
 123
 124 static GstStateChangeReturn gst_fake_sink_change_state (GstElement * element,
 125     GstStateChange transition);
 126
 127 static GstFlowReturn gst_fake_sink_preroll (GstBaseSink * bsink,
 128     GstBuffer * buffer);
 129 static GstFlowReturn gst_fake_sink_render (GstBaseSink * bsink,
 130     GstBuffer * buffer);
 131 static gboolean gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event);
 132
 133 static guint gst_fake_sink_signals[LAST_SIGNAL] = { 0 };
 134
 135 static void
 136 gst_fake_sink_base_init (gpointer g_class)
 137 {
 138   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 139
 140   gst_element_class_add_pad_template (gstelement_class,
 141       gst_static_pad_template_get (&sinktemplate));
 142   gst_element_class_set_details (gstelement_class, &gst_fake_sink_details);
 143 }
 144
 145 static void
 146 gst_fake_sink_class_init (GstFakeSinkClass * klass)
 147 {
 148   GObjectClass *gobject_class;
 149   GstElementClass *gstelement_class;
 150   GstBaseSinkClass *gstbase_sink_class;
 151
 152   gobject_class = (GObjectClass *) klass;
 153   gstelement_class = (GstElementClass *) klass;
 154   gstbase_sink_class = (GstBaseSinkClass *) klass;
 155
 156   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_fake_sink_set_property);
 157   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_fake_sink_get_property);
 158
 159   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_STATE_ERROR,
 160       g_param_spec_enum ("state_error", "State Error",
 161           "Generate a state change error", GST_TYPE_FAKE_SINK_STATE_ERROR,
 162           DEFAULT_STATE_ERROR, G_PARAM_READWRITE));
 163   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_LAST_MESSAGE,
 164       g_param_spec_string ("last_message", "Last Message",
 165           "The message describing current status", DEFAULT_LAST_MESSAGE,
 166           G_PARAM_READABLE));
 167   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SIGNAL_HANDOFFS,
 168       g_param_spec_boolean ("signal-handoffs", "Signal handoffs",
 169           "Send a signal before unreffing the buffer", DEFAULT_SIGNAL_HANDOFFS,
 170           G_PARAM_READWRITE));
 171   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SILENT,
 172       g_param_spec_boolean ("silent", "Silent",
 173           "Don't produce last_message events", DEFAULT_SILENT,
 174           G_PARAM_READWRITE));
 175   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DUMP,
 176       g_param_spec_boolean ("dump", "Dump", "Dump received bytes to stdout",
 177           DEFAULT_DUMP, G_PARAM_READWRITE));
 178   g_object_class_install_property (G_OBJECT_CLASS (klass),
 179       PROP_CAN_ACTIVATE_PUSH,
 180       g_param_spec_boolean ("can-activate-push", "Can activate push",
 181           "Can activate in push mode", DEFAULT_CAN_ACTIVATE_PUSH,
 182           G_PARAM_READWRITE));
 183   g_object_class_install_property (G_OBJECT_CLASS (klass),
 184       PROP_CAN_ACTIVATE_PULL,
 185       g_param_spec_boolean ("can-activate-pull", "Can activate pull",
 186           "Can activate in pull mode", DEFAULT_CAN_ACTIVATE_PULL,
 187           G_PARAM_READWRITE));
 188
 189   /**
 190    * GstFakeSink::handoff:
 191    * @fakesink: the fakesink instance
 192    * @buffer: the buffer that just has been received
 193    * @pad: the pad that received it
 194    *
 195    * This signal gets emitted before unreffing the buffer.
 196    */
 197   gst_fake_sink_signals[SIGNAL_HANDOFF] =
 198       g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 199       G_STRUCT_OFFSET (GstFakeSinkClass, handoff), NULL, NULL,
 200       gst_marshal_VOID__OBJECT_OBJECT, G_TYPE_NONE, 2,
 201       GST_TYPE_BUFFER, GST_TYPE_PAD);
 202
 203   gstelement_class->change_state =
 204       GST_DEBUG_FUNCPTR (gst_fake_sink_change_state);
 205
 206   gstbase_sink_class->event = GST_DEBUG_FUNCPTR (gst_fake_sink_event);
 207   gstbase_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_fake_sink_preroll);
 208   gstbase_sink_class->render = GST_DEBUG_FUNCPTR (gst_fake_sink_render);
 209 }
 210
 211 static void
 212 gst_fake_sink_init (GstFakeSink * fakesink, GstFakeSinkClass * g_class)
 213 {
 214   fakesink->silent = DEFAULT_SILENT;
 215   fakesink->dump = DEFAULT_DUMP;
 216   GST_BASE_SINK (fakesink)->sync = DEFAULT_SYNC;
 217   fakesink->last_message = g_strdup (DEFAULT_LAST_MESSAGE);
 218   fakesink->state_error = DEFAULT_STATE_ERROR;
 219   fakesink->signal_handoffs = DEFAULT_SIGNAL_HANDOFFS;
 220 }
 221
 222 static void
 223 gst_fake_sink_set_property (GObject * object, guint prop_id,
 224     const GValue * value, GParamSpec * pspec)
 225 {
 226   GstFakeSink *sink;
 227
 228   sink = GST_FAKE_SINK (object);
 229
 230   switch (prop_id) {
 231     case PROP_SILENT:
 232       sink->silent = g_value_get_boolean (value);
 233       break;
 234     case PROP_STATE_ERROR:
 235       sink->state_error = g_value_get_enum (value);
 236       break;
 237     case PROP_DUMP:
 238       sink->dump = g_value_get_boolean (value);
 239       break;
 240     case PROP_SIGNAL_HANDOFFS:
 241       sink->signal_handoffs = g_value_get_boolean (value);
 242       break;
 243     case PROP_CAN_ACTIVATE_PUSH:
 244       GST_BASE_SINK (sink)->can_activate_push = g_value_get_boolean (value);
 245       break;
 246     case PROP_CAN_ACTIVATE_PULL:
 247       GST_BASE_SINK (sink)->can_activate_pull = g_value_get_boolean (value);
 248       break;
 249     default:
 250       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 251       break;
 252   }
 253 }
 254
 255 static void
 256 gst_fake_sink_get_property (GObject * object, guint prop_id, GValue * value,
 257     GParamSpec * pspec)
 258 {
 259   GstFakeSink *sink;
 260
 261   sink = GST_FAKE_SINK (object);
 262
 263   switch (prop_id) {
 264     case PROP_STATE_ERROR:
 265       g_value_set_enum (value, sink->state_error);
 266       break;
 267     case PROP_SILENT:
 268       g_value_set_boolean (value, sink->silent);
 269       break;
 270     case PROP_DUMP:
 271       g_value_set_boolean (value, sink->dump);
 272       break;
 273     case PROP_SIGNAL_HANDOFFS:
 274       g_value_set_boolean (value, sink->signal_handoffs);
 275       break;
 276     case PROP_LAST_MESSAGE:
 277       GST_OBJECT_LOCK (sink);
 278       g_value_set_string (value, sink->last_message);
 279       GST_OBJECT_UNLOCK (sink);
 280       break;
 281     case PROP_CAN_ACTIVATE_PUSH:
 282       g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_push);
 283       break;
 284     case PROP_CAN_ACTIVATE_PULL:
 285       g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_pull);
 286       break;
 287     default:
 288       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 289       break;
 290   }
 291 }
 292
 293 static gboolean
 294 gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event)
 295 {
 296   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 297
 298   if (!sink->silent) {
 299     const GstStructure *s;
 300     gchar *sstr;
 301
 302     GST_OBJECT_LOCK (sink);
 303     g_free (sink->last_message);
 304
 305     if ((s = gst_event_get_structure (event)))
 306       sstr = gst_structure_to_string (s);
 307     else
 308       sstr = g_strdup ("");
 309
 310     sink->last_message =
 311         g_strdup_printf ("event   ******* E (type: %d, %s) %p",
 312         GST_EVENT_TYPE (event), sstr, event);
 313     g_free (sstr);
 314     GST_OBJECT_UNLOCK (sink);
 315
 316     g_object_notify (G_OBJECT (sink), "last_message");
 317   }
 318
 319   return TRUE;
 320 }
 321
 322 static GstFlowReturn
 323 gst_fake_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 324 {
 325   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 326
 327   if (!sink->silent) {
 328     GST_OBJECT_LOCK (sink);
 329     g_free (sink->last_message);
 330
 331     sink->last_message = g_strdup_printf ("preroll   ******* ");
 332     GST_OBJECT_UNLOCK (sink);
 333
 334     g_object_notify (G_OBJECT (sink), "last_message");
 335   }
 336   return GST_FLOW_OK;
 337 }
 338
 339 static GstFlowReturn
 340 gst_fake_sink_render (GstBaseSink * bsink, GstBuffer * buf)
 341 {
 342   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 343
 344   if (!sink->silent) {
 345     gchar ts_str[64], dur_str[64];
 346
 347     GST_OBJECT_LOCK (sink);
 348     g_free (sink->last_message);
 349
 350     if (GST_BUFFER_TIMESTAMP (buf) != GST_CLOCK_TIME_NONE) {
 351       g_snprintf (ts_str, sizeof (ts_str), "%" GST_TIME_FORMAT,
 352           GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
 353     } else {
 354       g_strlcpy (ts_str, "none", sizeof (ts_str));
 355     }
 356
 357     if (GST_BUFFER_DURATION (buf) != GST_CLOCK_TIME_NONE) {
 358       g_snprintf (dur_str, sizeof (dur_str), "%" GST_TIME_FORMAT,
 359           GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
 360     } else {
 361       g_strlcpy (dur_str, "none", sizeof (dur_str));
 362     }
 363
 364     sink->last_message =
 365         g_strdup_printf ("chain   ******* < (%5d bytes, timestamp: %s"
 366         ", duration: %s, offset: %" G_GINT64_FORMAT ", offset_end: %"
 367         G_GINT64_FORMAT ", flags: %d) %p", GST_BUFFER_SIZE (buf), ts_str,
 368         dur_str, GST_BUFFER_OFFSET (buf), GST_BUFFER_OFFSET_END (buf),
 369         GST_MINI_OBJECT (buf)->flags, buf);
 370     GST_OBJECT_UNLOCK (sink);
 371
 372     g_object_notify (G_OBJECT (sink), "last_message");
 373   }
 374   if (sink->signal_handoffs)
 375     g_signal_emit (G_OBJECT (sink), gst_fake_sink_signals[SIGNAL_HANDOFF], 0,
 376         buf, bsink->sinkpad);
 377
 378   if (sink->dump) {
 379     gst_util_dump_mem (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf));
 380   }
 381
 382   return GST_FLOW_OK;
 383 }
 384
 385 static GstStateChangeReturn
 386 gst_fake_sink_change_state (GstElement * element, GstStateChange transition)
 387 {
 388   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 389   GstFakeSink *fakesink = GST_FAKE_SINK (element);
 390
 391   switch (transition) {
 392     case GST_STATE_CHANGE_NULL_TO_READY:
 393       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_NULL_READY)
 394         goto error;
 395       break;
 396     case GST_STATE_CHANGE_READY_TO_PAUSED:
 397       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_PAUSED)
 398         goto error;
 399       break;
 400     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 401       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_PLAYING)
 402         goto error;
 403       break;
 404     default:
 405       break;
 406   }
 407
 408   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 409
 410   switch (transition) {
 411     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 412       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PLAYING_PAUSED)
 413         goto error;
 414       break;
 415     case GST_STATE_CHANGE_PAUSED_TO_READY:
 416       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_READY)
 417         goto error;
 418       break;
 419     case GST_STATE_CHANGE_READY_TO_NULL:
 420       if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_NULL)
 421         goto error;
 422       GST_OBJECT_LOCK (fakesink);
 423       g_free (fakesink->last_message);
 424       fakesink->last_message = NULL;
 425       GST_OBJECT_UNLOCK (fakesink);
 426       break;
 427     default:
 428       break;
 429   }
 430
 431   return ret;
 432
 433   /* ERROR */
 434 error:
 435   GST_ELEMENT_ERROR (element, CORE, STATE_CHANGE, (NULL), (NULL));
 436   return GST_STATE_CHANGE_FAILURE;
 437 }