2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
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.
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.
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.
23 * SECTION:element-fakesink
24 * @see_also: #GstFakeSrc
26 * Dummy sink that swallows everything.
29 * <title>Example launch line</title>
31 * gst-launch audiotestsrc num-buffers=1000 ! fakesink sync=false
32 * ]| Render 1000 audio buffers (of default size) as fast as possible.
40 #include "gstfakesink.h"
43 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
48 GST_DEBUG_CATEGORY_STATIC (gst_fake_sink_debug);
49 #define GST_CAT_DEFAULT gst_fake_sink_debug
51 /* FakeSink signals and args */
56 SIGNAL_PREROLL_HANDOFF,
60 #define DEFAULT_SYNC FALSE
62 #define DEFAULT_STATE_ERROR FAKE_SINK_STATE_ERROR_NONE
63 #define DEFAULT_SILENT TRUE
64 #define DEFAULT_DUMP 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 #define DEFAULT_NUM_BUFFERS -1
79 PROP_CAN_ACTIVATE_PUSH,
80 PROP_CAN_ACTIVATE_PULL,
84 #define GST_TYPE_FAKE_SINK_STATE_ERROR (gst_fake_sink_state_error_get_type())
86 gst_fake_sink_state_error_get_type (void)
88 static GType fakesink_state_error_type = 0;
89 static const 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"},
106 if (!fakesink_state_error_type) {
107 fakesink_state_error_type =
108 g_enum_register_static ("GstFakeSinkStateError", fakesink_state_error);
110 return fakesink_state_error_type;
114 GST_DEBUG_CATEGORY_INIT (gst_fake_sink_debug, "fakesink", 0, "fakesink element");
115 #define gst_fake_sink_parent_class parent_class
116 G_DEFINE_TYPE_WITH_CODE (GstFakeSink, gst_fake_sink, GST_TYPE_BASE_SINK,
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 static void gst_fake_sink_finalize (GObject * obj);
125 static GstStateChangeReturn gst_fake_sink_change_state (GstElement * element,
126 GstStateChange transition);
128 static GstFlowReturn gst_fake_sink_preroll (GstBaseSink * bsink,
130 static GstFlowReturn gst_fake_sink_render (GstBaseSink * bsink,
132 static gboolean gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event);
133 static gboolean gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query);
135 static guint gst_fake_sink_signals[LAST_SIGNAL] = { 0 };
137 static GParamSpec *pspec_last_message = NULL;
140 gst_fake_sink_class_init (GstFakeSinkClass * klass)
142 GObjectClass *gobject_class;
143 GstElementClass *gstelement_class;
144 GstBaseSinkClass *gstbase_sink_class;
146 gobject_class = G_OBJECT_CLASS (klass);
147 gstelement_class = GST_ELEMENT_CLASS (klass);
148 gstbase_sink_class = GST_BASE_SINK_CLASS (klass);
150 gobject_class->set_property = gst_fake_sink_set_property;
151 gobject_class->get_property = gst_fake_sink_get_property;
152 gobject_class->finalize = gst_fake_sink_finalize;
154 g_object_class_install_property (gobject_class, PROP_STATE_ERROR,
155 g_param_spec_enum ("state-error", "State Error",
156 "Generate a state change error", GST_TYPE_FAKE_SINK_STATE_ERROR,
157 DEFAULT_STATE_ERROR, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
158 pspec_last_message = g_param_spec_string ("last-message", "Last Message",
159 "The message describing current status", DEFAULT_LAST_MESSAGE,
160 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
161 g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
163 g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
164 g_param_spec_boolean ("signal-handoffs", "Signal handoffs",
165 "Send a signal before unreffing the buffer", DEFAULT_SIGNAL_HANDOFFS,
166 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
167 g_object_class_install_property (gobject_class, PROP_SILENT,
168 g_param_spec_boolean ("silent", "Silent",
169 "Don't produce last_message events", DEFAULT_SILENT,
170 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
171 g_object_class_install_property (gobject_class, PROP_DUMP,
172 g_param_spec_boolean ("dump", "Dump", "Dump buffer contents to stdout",
173 DEFAULT_DUMP, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
174 g_object_class_install_property (gobject_class,
175 PROP_CAN_ACTIVATE_PUSH,
176 g_param_spec_boolean ("can-activate-push", "Can activate push",
177 "Can activate in push mode", DEFAULT_CAN_ACTIVATE_PUSH,
178 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
179 g_object_class_install_property (gobject_class,
180 PROP_CAN_ACTIVATE_PULL,
181 g_param_spec_boolean ("can-activate-pull", "Can activate pull",
182 "Can activate in pull mode", DEFAULT_CAN_ACTIVATE_PULL,
183 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
184 g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS,
185 g_param_spec_int ("num-buffers", "num-buffers",
186 "Number of buffers to accept going EOS", -1, G_MAXINT,
187 DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
190 * GstFakeSink::handoff:
191 * @fakesink: the fakesink instance
192 * @buffer: the buffer that just has been received
193 * @pad: the pad that received it
195 * This signal gets emitted before unreffing the buffer.
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 g_cclosure_marshal_generic, G_TYPE_NONE, 2,
201 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
204 * GstFakeSink::preroll-handoff:
205 * @fakesink: the fakesink instance
206 * @buffer: the buffer that just has been received
207 * @pad: the pad that received it
209 * This signal gets emitted before unreffing the buffer.
211 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF] =
212 g_signal_new ("preroll-handoff", G_TYPE_FROM_CLASS (klass),
213 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstFakeSinkClass, preroll_handoff),
214 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
215 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
217 gst_element_class_set_static_metadata (gstelement_class,
220 "Black hole for data",
221 "Erik Walthinsen <omega@cse.ogi.edu>, "
222 "Wim Taymans <wim@fluendo.com>, "
223 "Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com>");
224 gst_element_class_add_pad_template (gstelement_class,
225 gst_static_pad_template_get (&sinktemplate));
227 gstelement_class->change_state =
228 GST_DEBUG_FUNCPTR (gst_fake_sink_change_state);
230 gstbase_sink_class->event = GST_DEBUG_FUNCPTR (gst_fake_sink_event);
231 gstbase_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_fake_sink_preroll);
232 gstbase_sink_class->render = GST_DEBUG_FUNCPTR (gst_fake_sink_render);
233 gstbase_sink_class->query = GST_DEBUG_FUNCPTR (gst_fake_sink_query);
237 gst_fake_sink_init (GstFakeSink * fakesink)
239 fakesink->silent = DEFAULT_SILENT;
240 fakesink->dump = DEFAULT_DUMP;
241 fakesink->last_message = g_strdup (DEFAULT_LAST_MESSAGE);
242 fakesink->state_error = DEFAULT_STATE_ERROR;
243 fakesink->signal_handoffs = DEFAULT_SIGNAL_HANDOFFS;
244 fakesink->num_buffers = DEFAULT_NUM_BUFFERS;
246 gst_base_sink_set_sync (GST_BASE_SINK (fakesink), DEFAULT_SYNC);
250 gst_fake_sink_finalize (GObject * obj)
252 G_OBJECT_CLASS (parent_class)->finalize (obj);
256 gst_fake_sink_set_property (GObject * object, guint prop_id,
257 const GValue * value, GParamSpec * pspec)
261 sink = GST_FAKE_SINK (object);
264 case PROP_STATE_ERROR:
265 sink->state_error = (GstFakeSinkStateError) g_value_get_enum (value);
268 sink->silent = g_value_get_boolean (value);
271 sink->dump = g_value_get_boolean (value);
273 case PROP_SIGNAL_HANDOFFS:
274 sink->signal_handoffs = g_value_get_boolean (value);
276 case PROP_CAN_ACTIVATE_PUSH:
277 GST_BASE_SINK (sink)->can_activate_push = g_value_get_boolean (value);
279 case PROP_CAN_ACTIVATE_PULL:
280 GST_BASE_SINK (sink)->can_activate_pull = g_value_get_boolean (value);
282 case PROP_NUM_BUFFERS:
283 sink->num_buffers = g_value_get_int (value);
286 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
292 gst_fake_sink_get_property (GObject * object, guint prop_id, GValue * value,
297 sink = GST_FAKE_SINK (object);
300 case PROP_STATE_ERROR:
301 g_value_set_enum (value, sink->state_error);
304 g_value_set_boolean (value, sink->silent);
307 g_value_set_boolean (value, sink->dump);
309 case PROP_SIGNAL_HANDOFFS:
310 g_value_set_boolean (value, sink->signal_handoffs);
312 case PROP_LAST_MESSAGE:
313 GST_OBJECT_LOCK (sink);
314 g_value_set_string (value, sink->last_message);
315 GST_OBJECT_UNLOCK (sink);
317 case PROP_CAN_ACTIVATE_PUSH:
318 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_push);
320 case PROP_CAN_ACTIVATE_PULL:
321 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_pull);
323 case PROP_NUM_BUFFERS:
324 g_value_set_int (value, sink->num_buffers);
327 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
333 gst_fake_sink_notify_last_message (GstFakeSink * sink)
335 g_object_notify_by_pspec ((GObject *) sink, pspec_last_message);
339 gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event)
341 GstFakeSink *sink = GST_FAKE_SINK (bsink);
344 const GstStructure *s;
348 GST_OBJECT_LOCK (sink);
349 g_free (sink->last_message);
351 if (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE) {
353 const GstStructure *structure;
355 gst_event_parse_sink_message (event, &msg);
356 structure = gst_message_get_structure (msg);
357 sstr = gst_structure_to_string (structure);
359 g_strdup_printf ("message ******* (%s:%s) M (type: %d, %s) %p",
360 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
361 GST_MESSAGE_TYPE (msg), sstr, msg);
362 gst_message_unref (msg);
364 tstr = gst_event_type_get_name (GST_EVENT_TYPE (event));
366 if ((s = gst_event_get_structure (event))) {
367 sstr = gst_structure_to_string (s);
369 sstr = g_strdup ("");
373 g_strdup_printf ("event ******* (%s:%s) E (type: %s (%d), %s) %p",
374 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
375 tstr, GST_EVENT_TYPE (event), sstr, event);
378 GST_OBJECT_UNLOCK (sink);
380 gst_fake_sink_notify_last_message (sink);
383 return GST_BASE_SINK_CLASS (parent_class)->event (bsink, event);
387 gst_fake_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
389 GstFakeSink *sink = GST_FAKE_SINK (bsink);
391 if (sink->num_buffers_left == 0)
395 GST_OBJECT_LOCK (sink);
396 g_free (sink->last_message);
398 sink->last_message = g_strdup_printf ("preroll ******* ");
399 GST_OBJECT_UNLOCK (sink);
401 gst_fake_sink_notify_last_message (sink);
403 if (sink->signal_handoffs) {
405 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF], 0, buffer,
413 GST_DEBUG_OBJECT (sink, "we are EOS");
419 gst_fake_sink_render (GstBaseSink * bsink, GstBuffer * buf)
421 GstFakeSink *sink = GST_FAKE_SINK_CAST (bsink);
423 if (sink->num_buffers_left == 0)
426 if (sink->num_buffers_left != -1)
427 sink->num_buffers_left--;
430 gchar dts_str[64], pts_str[64], dur_str[64];
433 GST_OBJECT_LOCK (sink);
434 g_free (sink->last_message);
436 if (GST_BUFFER_DTS (buf) != GST_CLOCK_TIME_NONE) {
437 g_snprintf (dts_str, sizeof (dts_str), "%" GST_TIME_FORMAT,
438 GST_TIME_ARGS (GST_BUFFER_DTS (buf)));
440 g_strlcpy (dts_str, "none", sizeof (dts_str));
443 if (GST_BUFFER_PTS (buf) != GST_CLOCK_TIME_NONE) {
444 g_snprintf (pts_str, sizeof (pts_str), "%" GST_TIME_FORMAT,
445 GST_TIME_ARGS (GST_BUFFER_PTS (buf)));
447 g_strlcpy (pts_str, "none", sizeof (pts_str));
450 if (GST_BUFFER_DURATION (buf) != GST_CLOCK_TIME_NONE) {
451 g_snprintf (dur_str, sizeof (dur_str), "%" GST_TIME_FORMAT,
452 GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
454 g_strlcpy (dur_str, "none", sizeof (dur_str));
458 const char *flag_list[15] = {
459 "", "", "", "", "live", "decode-only", "discont", "resync", "corrupted",
460 "marker", "header", "gap", "droppable", "delta-unit", "in-caps"
463 char *end = flag_str;
465 for (i = 0; i < G_N_ELEMENTS (flag_list); i++) {
466 if (GST_MINI_OBJECT_CAST (buf)->flags & (1 << i)) {
467 strcpy (end, flag_list[i]);
477 g_strdup_printf ("chain ******* (%s:%s) (%u bytes, dts: %s, pts: %s"
478 ", duration: %s, offset: %" G_GINT64_FORMAT ", offset_end: %"
479 G_GINT64_FORMAT ", flags: %08x %s) %p",
480 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
481 (guint) gst_buffer_get_size (buf), dts_str, pts_str,
482 dur_str, GST_BUFFER_OFFSET (buf), GST_BUFFER_OFFSET_END (buf),
483 GST_MINI_OBJECT_CAST (buf)->flags, flag_str, buf);
484 GST_OBJECT_UNLOCK (sink);
486 gst_fake_sink_notify_last_message (sink);
488 if (sink->signal_handoffs)
489 g_signal_emit (sink, gst_fake_sink_signals[SIGNAL_HANDOFF], 0, buf,
495 gst_buffer_map (buf, &info, GST_MAP_READ);
496 gst_util_dump_mem (info.data, info.size);
497 gst_buffer_unmap (buf, &info);
499 if (sink->num_buffers_left == 0)
507 GST_DEBUG_OBJECT (sink, "we are EOS");
513 gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query)
517 switch (GST_QUERY_TYPE (query)) {
518 case GST_QUERY_SEEKING:{
521 /* we don't supporting seeking */
522 gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
523 gst_query_set_seeking (query, fmt, FALSE, 0, -1);
528 ret = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
535 static GstStateChangeReturn
536 gst_fake_sink_change_state (GstElement * element, GstStateChange transition)
538 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
539 GstFakeSink *fakesink = GST_FAKE_SINK (element);
541 switch (transition) {
542 case GST_STATE_CHANGE_NULL_TO_READY:
543 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_NULL_READY)
546 case GST_STATE_CHANGE_READY_TO_PAUSED:
547 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_PAUSED)
549 fakesink->num_buffers_left = fakesink->num_buffers;
551 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
552 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_PLAYING)
559 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
561 switch (transition) {
562 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
563 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PLAYING_PAUSED)
566 case GST_STATE_CHANGE_PAUSED_TO_READY:
567 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_READY)
570 case GST_STATE_CHANGE_READY_TO_NULL:
571 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_NULL)
573 GST_OBJECT_LOCK (fakesink);
574 g_free (fakesink->last_message);
575 fakesink->last_message = NULL;
576 GST_OBJECT_UNLOCK (fakesink);
586 GST_ELEMENT_ERROR (element, CORE, STATE_CHANGE, (NULL),
587 ("Erroring out on state change as requested"));
588 return GST_STATE_CHANGE_FAILURE;