gst/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:gstfakesink
  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 GstElementDetails gst_fake_sink_details = GST_ELEMENT_DETAILS ("Fake Sink",
  46     "Sink",
  47     "Black hole for data",
  48     "Erik Walthinsen <omega@cse.ogi.edu>, "
  49     "Wim Taymans <wim@fluendo.com>, "
  50     "Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com>");
  51
  52
  53 /* FakeSink signals and args */
  54 enum
  55 {
  56   /* FILL ME */
  57   SIGNAL_HANDOFF,
  58   LAST_SIGNAL
  59 };
  60
  61 #define DEFAULT_STATE_ERROR FAKE_SINK_STATE_ERROR_NONE
  62 #define DEFAULT_SILENT FALSE
  63 #define DEFAULT_DUMP FALSE
  64 #define DEFAULT_SYNC FALSE
  65 #define DEFAULT_SIGNAL_HANDOFFS FALSE
  66 #define DEFAULT_LAST_MESSAGE NULL
  67 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
  68 #define DEFAULT_CAN_ACTIVATE_PULL FALSE
  69
  70 enum
  71 {
  72   PROP_0,
  73   PROP_STATE_ERROR,
  74   PROP_SILENT,
  75   PROP_DUMP,
  76   PROP_SYNC,
  77   PROP_SIGNAL_HANDOFFS,
  78   PROP_LAST_MESSAGE,
  79   PROP_CAN_ACTIVATE_PUSH,
  80   PROP_CAN_ACTIVATE_PULL
  81 };
  82
  83 #define GST_TYPE_FAKE_SINK_STATE_ERROR (gst_fake_sink_state_error_get_type())
  84 static GType
  85 gst_fake_sink_state_error_get_type (void)
  86 {
  87   static GType fakesink_state_error_type = 0;
  88   static GEnumValue fakesink_state_error[] = {
  89     {FAKE_SINK_STATE_ERROR_NONE, "0", "No state change errors"},
  90     {FAKE_SINK_STATE_ERROR_NULL_READY, "1",
  91         "Fail state change from NULL to READY"},
  92     {FAKE_SINK_STATE_ERROR_READY_PAUSED, "2",
  93         "Fail state change from READY to PAUSED"},
  94     {FAKE_SINK_STATE_ERROR_PAUSED_PLAYING, "3",
  95         "Fail state change from PAUSED to PLAYING"},
  96     {FAKE_SINK_STATE_ERROR_PLAYING_PAUSED, "4",
  97         "Fail state change from PLAYING to PAUSED"},
  98     {FAKE_SINK_STATE_ERROR_PAUSED_READY, "5",
  99         "Fail state change from PAUSED to READY"},
 100     {FAKE_SINK_STATE_ERROR_READY_NULL, "6",
 101         "Fail state change from READY to NULL"},
 102     {0, NULL, NULL},
 103   };
 104
 105   if (!fakesink_state_error_type) {
 106     fakesink_state_error_type =
 107         g_enum_register_static ("GstFakeSinkStateError", fakesink_state_error);
 108   }
 109   return fakesink_state_error_type;
 110 }
 111
 112 #define _do_init(bla) \
 113     GST_DEBUG_CATEGORY_INIT (gst_fake_sink_debug, "fakesink", 0, "fakesink element");
 114
 115 GST_BOILERPLATE_FULL (GstFakeSink, gst_fake_sink, GstBaseSink,
 116     GST_TYPE_BASE_SINK, _do_init);
 117
 118 static void gst_fake_sink_set_property (GObject * object, guint prop_id,
 119     const GValue * value, GParamSpec * pspec);
 120 static void gst_fake_sink_get_property (GObject * object, guint prop_id,
 121     GValue * value, GParamSpec * pspec);
 122
 123 static GstStateChangeReturn gst_fake_sink_change_state (GstElement * element,
 124     GstStateChange transition);
 125
 126 static GstFlowReturn gst_fake_sink_preroll (GstBaseSink * bsink,
 127     GstBuffer * buffer);
 128 static GstFlowReturn gst_fake_sink_render (GstBaseSink * bsink,
 129     GstBuffer * buffer);
 130 static gboolean gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event);
 131 static void gst_fake_sink_get_times (GstBaseSink * bsink, GstBuffer * buffer,
 132     GstClockTime * start, GstClockTime * end);
 133
 134 static guint gst_fake_sink_signals[LAST_SIGNAL] = { 0 };
 135
 136 static void
 137 gst_fake_sink_base_init (gpointer g_class)
 138 {
 139   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 140
 141   gst_element_class_add_pad_template (gstelement_class,
 142       gst_static_pad_template_get (&sinktemplate));
 143   gst_element_class_set_details (gstelement_class, &gst_fake_sink_details);
 144 }
 145
 146 static void
 147 gst_fake_sink_class_init (GstFakeSinkClass * klass)
 148 {
 149   GObjectClass *gobject_class;
 150   GstElementClass *gstelement_class;
 151   GstBaseSinkClass *gstbase_sink_class;
 152
 153   gobject_class = (GObjectClass *) klass;
 154   gstelement_class = (GstElementClass *) klass;
 155   gstbase_sink_class = (GstBaseSinkClass *) klass;
 156
 157   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_fake_sink_set_property);
 158   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_fake_sink_get_property);
 159
 160   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_STATE_ERROR,
 161       g_param_spec_enum ("state_error", "State Error",
 162           "Generate a state change error", GST_TYPE_FAKE_SINK_STATE_ERROR,
 163           DEFAULT_STATE_ERROR, G_PARAM_READWRITE));
 164   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_LAST_MESSAGE,
 165       g_param_spec_string ("last_message", "Last Message",
 166           "The message describing current status", DEFAULT_LAST_MESSAGE,
 167           G_PARAM_READABLE));
 168   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SYNC,
 169       g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
 170           G_PARAM_READWRITE));
 171   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SIGNAL_HANDOFFS,
 172       g_param_spec_boolean ("signal-handoffs", "Signal handoffs",
 173           "Send a signal before unreffing the buffer", DEFAULT_SIGNAL_HANDOFFS,
 174           G_PARAM_READWRITE));
 175   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SILENT,
 176       g_param_spec_boolean ("silent", "Silent",
 177           "Don't produce last_message events", DEFAULT_SILENT,
 178           G_PARAM_READWRITE));
 179   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DUMP,
 180       g_param_spec_boolean ("dump", "Dump", "Dump received bytes to stdout",
 181           DEFAULT_DUMP, G_PARAM_READWRITE));
 182   g_object_class_install_property (G_OBJECT_CLASS (klass),
 183       PROP_CAN_ACTIVATE_PUSH,
 184       g_param_spec_boolean ("can-activate-push", "Can activate push",
 185           "Can activate in push mode", DEFAULT_CAN_ACTIVATE_PUSH,
 186           G_PARAM_READWRITE));
 187   g_object_class_install_property (G_OBJECT_CLASS (klass),
 188       PROP_CAN_ACTIVATE_PULL,
 189       g_param_spec_boolean ("can-activate-pull", "Can activate pull",
 190           "Can activate in pull mode", DEFAULT_CAN_ACTIVATE_PULL,
 191           G_PARAM_READWRITE));
 192
 193   /**
 194    * GstFakeSink::handoff:
 195    * @fakesink: the fakesink instance
 196    * @buffer: the buffer that just has been received
 197    * @pad: the pad that received it
 198    *
 199    * This signal gets emitted before unreffing the buffer.
 200    */
 201   gst_fake_sink_signals[SIGNAL_HANDOFF] =
 202       g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 203       G_STRUCT_OFFSET (GstFakeSinkClass, handoff), NULL, NULL,
 204       gst_marshal_VOID__OBJECT_OBJECT, G_TYPE_NONE, 2,
 205       GST_TYPE_BUFFER, GST_TYPE_PAD);
 206
 207   gstelement_class->change_state =
 208       GST_DEBUG_FUNCPTR (gst_fake_sink_change_state);
 209
 210   gstbase_sink_class->event = GST_DEBUG_FUNCPTR (gst_fake_sink_event);
 211   gstbase_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_fake_sink_preroll);
 212   gstbase_sink_class->render = GST_DEBUG_FUNCPTR (gst_fake_sink_render);
 213   gstbase_sink_class->get_times = GST_DEBUG_FUNCPTR (gst_fake_sink_get_times);
 214 }
 215
 216 static void
 217 gst_fake_sink_init (GstFakeSink * fakesink, GstFakeSinkClass * g_class)
 218 {
 219   fakesink->silent = DEFAULT_SILENT;
 220   fakesink->dump = DEFAULT_DUMP;
 221   fakesink->sync = DEFAULT_SYNC;
 222   fakesink->last_message = g_strdup (DEFAULT_LAST_MESSAGE);
 223   fakesink->state_error = DEFAULT_STATE_ERROR;
 224   fakesink->signal_handoffs = DEFAULT_SIGNAL_HANDOFFS;
 225 }
 226
 227 static void
 228 gst_fake_sink_set_property (GObject * object, guint prop_id,
 229     const GValue * value, GParamSpec * pspec)
 230 {
 231   GstFakeSink *sink;
 232
 233   sink = GST_FAKE_SINK (object);
 234
 235   switch (prop_id) {
 236     case PROP_SILENT:
 237       sink->silent = g_value_get_boolean (value);
 238       break;
 239     case PROP_STATE_ERROR:
 240       sink->state_error = g_value_get_enum (value);
 241       break;
 242     case PROP_DUMP:
 243       sink->dump = g_value_get_boolean (value);
 244       break;
 245     case PROP_SYNC:
 246       sink->sync = g_value_get_boolean (value);
 247       break;
 248     case PROP_SIGNAL_HANDOFFS:
 249       sink->signal_handoffs = g_value_get_boolean (value);
 250       break;
 251     case PROP_CAN_ACTIVATE_PUSH:
 252       GST_BASE_SINK (sink)->can_activate_push = g_value_get_boolean (value);
 253       break;
 254     case PROP_CAN_ACTIVATE_PULL:
 255       GST_BASE_SINK (sink)->can_activate_pull = g_value_get_boolean (value);
 256       break;
 257     default:
 258       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 259       break;
 260   }
 261 }
 262
 263 static void
 264 gst_fake_sink_get_property (GObject * object, guint prop_id, GValue * value,
 265     GParamSpec * pspec)
 266 {
 267   GstFakeSink *sink;
 268
 269   sink = GST_FAKE_SINK (object);
 270
 271   switch (prop_id) {
 272     case PROP_STATE_ERROR:
 273       g_value_set_enum (value, sink->state_error);
 274       break;
 275     case PROP_SILENT:
 276       g_value_set_boolean (value, sink->silent);
 277       break;
 278     case PROP_DUMP:
 279       g_value_set_boolean (value, sink->dump);
 280       break;
 281     case PROP_SYNC:
 282       g_value_set_boolean (value, sink->sync);
 283       break;
 284     case PROP_SIGNAL_HANDOFFS:
 285       g_value_set_boolean (value, sink->signal_handoffs);
 286       break;
 287     case PROP_LAST_MESSAGE:
 288       g_value_set_string (value, sink->last_message);
 289       break;
 290     case PROP_CAN_ACTIVATE_PUSH:
 291       g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_push);
 292       break;
 293     case PROP_CAN_ACTIVATE_PULL:
 294       g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_pull);
 295       break;
 296     default:
 297       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 298       break;
 299   }
 300 }
 301
 302 static void
 303 gst_fake_sink_get_times (GstBaseSink * bsink, GstBuffer * buffer,
 304     GstClockTime * start, GstClockTime * end)
 305 {
 306   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 307
 308   if (sink->sync) {
 309     GST_BASE_SINK_CLASS (parent_class)->get_times (bsink, buffer, start, end);
 310   }
 311 }
 312
 313 static gboolean
 314 gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event)
 315 {
 316   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 317   const GstStructure *s;
 318
 319   if (!sink->silent) {
 320     gchar *sstr;
 321
 322     g_free (sink->last_message);
 323
 324     if ((s = gst_event_get_structure (event)))
 325       sstr = gst_structure_to_string (s);
 326     else
 327       sstr = g_strdup ("");
 328
 329     sink->last_message =
 330         g_strdup_printf ("event   ******* E (type: %d, %s) %p",
 331         GST_EVENT_TYPE (event), sstr, event);
 332     g_free (sstr);
 333
 334     g_object_notify (G_OBJECT (sink), "last_message");
 335   }
 336
 337   return TRUE;
 338 }
 339
 340 static GstFlowReturn
 341 gst_fake_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 342 {
 343   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 344
 345   if (!sink->silent) {
 346     g_free (sink->last_message);
 347
 348     sink->last_message = g_strdup_printf ("preroll   ******* ");
 349
 350     g_object_notify (G_OBJECT (sink), "last_message");
 351   }
 352   return GST_FLOW_OK;
 353 }
 354
 355 static GstFlowReturn
 356 gst_fake_sink_render (GstBaseSink * bsink, GstBuffer * buf)
 357 {
 358   GstFakeSink *sink = GST_FAKE_SINK (bsink);
 359
 360   if (!sink->silent) {
 361     g_free (sink->last_message);
 362
 363     sink->last_message =
 364         g_strdup_printf ("chain   ******* < (%d bytes, timestamp: %"
 365         GST_TIME_FORMAT ", duration: %" GST_TIME_FORMAT ", offset: %"
 366         G_GINT64_FORMAT ", offset_end: %" G_GINT64_FORMAT ", flags: %d) %p",
 367         GST_BUFFER_SIZE (buf),
 368         GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)),
 369         GST_TIME_ARGS (GST_BUFFER_DURATION (buf)), GST_BUFFER_OFFSET (buf),
 370         GST_BUFFER_OFFSET_END (buf), GST_MINI_OBJECT (buf)->flags, buf);
 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       g_free (fakesink->last_message);
 423       fakesink->last_message = NULL;
 424       break;
 425     default:
 426       break;
 427   }
 428
 429   return ret;
 430
 431 error:
 432   GST_ELEMENT_ERROR (element, CORE, STATE_CHANGE, (NULL), (NULL));
 433   return GST_STATE_CHANGE_FAILURE;
 434 }