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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
23 * SECTION:element-fakesink
24 * @see_also: #GstFakeSrc
26 * Dummy sink that swallows everything.
29 * <title>Example launch line</title>
31 * gst-launch-1.0 audiotestsrc num-buffers=1000 ! fakesink sync=false
32 * ]| Render 1000 audio buffers (of default size) as fast as possible.
40 #include "gstelements_private.h"
41 #include "gstfakesink.h"
44 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
49 GST_DEBUG_CATEGORY_STATIC (gst_fake_sink_debug);
50 #define GST_CAT_DEFAULT gst_fake_sink_debug
52 /* FakeSink signals and args */
57 SIGNAL_PREROLL_HANDOFF,
61 #define DEFAULT_SYNC FALSE
62 #define DEFAULT_DROP_OUT_OF_SEGMENT TRUE
64 #define DEFAULT_STATE_ERROR FAKE_SINK_STATE_ERROR_NONE
65 #define DEFAULT_SILENT TRUE
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 #define DEFAULT_NUM_BUFFERS -1
80 PROP_DROP_OUT_OF_SEGMENT,
82 PROP_CAN_ACTIVATE_PUSH,
83 PROP_CAN_ACTIVATE_PULL,
87 #define GST_TYPE_FAKE_SINK_STATE_ERROR (gst_fake_sink_state_error_get_type())
89 gst_fake_sink_state_error_get_type (void)
91 static GType fakesink_state_error_type = 0;
92 static const GEnumValue fakesink_state_error[] = {
93 {FAKE_SINK_STATE_ERROR_NONE, "No state change errors", "none"},
94 {FAKE_SINK_STATE_ERROR_NULL_READY,
95 "Fail state change from NULL to READY", "null-to-ready"},
96 {FAKE_SINK_STATE_ERROR_READY_PAUSED,
97 "Fail state change from READY to PAUSED", "ready-to-paused"},
98 {FAKE_SINK_STATE_ERROR_PAUSED_PLAYING,
99 "Fail state change from PAUSED to PLAYING", "paused-to-playing"},
100 {FAKE_SINK_STATE_ERROR_PLAYING_PAUSED,
101 "Fail state change from PLAYING to PAUSED", "playing-to-paused"},
102 {FAKE_SINK_STATE_ERROR_PAUSED_READY,
103 "Fail state change from PAUSED to READY", "paused-to-ready"},
104 {FAKE_SINK_STATE_ERROR_READY_NULL,
105 "Fail state change from READY to NULL", "ready-to-null"},
109 if (!fakesink_state_error_type) {
110 fakesink_state_error_type =
111 g_enum_register_static ("GstFakeSinkStateError", fakesink_state_error);
113 return fakesink_state_error_type;
117 GST_DEBUG_CATEGORY_INIT (gst_fake_sink_debug, "fakesink", 0, "fakesink element");
118 #define gst_fake_sink_parent_class parent_class
119 G_DEFINE_TYPE_WITH_CODE (GstFakeSink, gst_fake_sink, GST_TYPE_BASE_SINK,
122 static void gst_fake_sink_set_property (GObject * object, guint prop_id,
123 const GValue * value, GParamSpec * pspec);
124 static void gst_fake_sink_get_property (GObject * object, guint prop_id,
125 GValue * value, GParamSpec * pspec);
126 static void gst_fake_sink_finalize (GObject * obj);
128 static GstStateChangeReturn gst_fake_sink_change_state (GstElement * element,
129 GstStateChange transition);
131 static GstFlowReturn gst_fake_sink_preroll (GstBaseSink * bsink,
133 static GstFlowReturn gst_fake_sink_render (GstBaseSink * bsink,
135 static gboolean gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event);
136 static gboolean gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query);
138 static guint gst_fake_sink_signals[LAST_SIGNAL] = { 0 };
140 static GParamSpec *pspec_last_message = NULL;
143 gst_fake_sink_class_init (GstFakeSinkClass * klass)
145 GObjectClass *gobject_class;
146 GstElementClass *gstelement_class;
147 GstBaseSinkClass *gstbase_sink_class;
149 gobject_class = G_OBJECT_CLASS (klass);
150 gstelement_class = GST_ELEMENT_CLASS (klass);
151 gstbase_sink_class = GST_BASE_SINK_CLASS (klass);
153 gobject_class->set_property = gst_fake_sink_set_property;
154 gobject_class->get_property = gst_fake_sink_get_property;
155 gobject_class->finalize = gst_fake_sink_finalize;
157 g_object_class_install_property (gobject_class, PROP_STATE_ERROR,
158 g_param_spec_enum ("state-error", "State Error",
159 "Generate a state change error", GST_TYPE_FAKE_SINK_STATE_ERROR,
160 DEFAULT_STATE_ERROR, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
161 pspec_last_message = g_param_spec_string ("last-message", "Last Message",
162 "The message describing current status", DEFAULT_LAST_MESSAGE,
163 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
164 g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
166 g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
167 g_param_spec_boolean ("signal-handoffs", "Signal handoffs",
168 "Send a signal before unreffing the buffer", DEFAULT_SIGNAL_HANDOFFS,
169 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
170 g_object_class_install_property (gobject_class, PROP_DROP_OUT_OF_SEGMENT,
171 g_param_spec_boolean ("drop-out-of-segment",
172 "Drop out-of-segment buffers",
173 "Drop and don't render / hand off out-of-segment buffers",
174 DEFAULT_DROP_OUT_OF_SEGMENT,
175 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
176 g_object_class_install_property (gobject_class, PROP_SILENT,
177 g_param_spec_boolean ("silent", "Silent",
178 "Don't produce last_message events", DEFAULT_SILENT,
179 G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
180 G_PARAM_STATIC_STRINGS));
181 g_object_class_install_property (gobject_class, PROP_DUMP,
182 g_param_spec_boolean ("dump", "Dump", "Dump buffer contents to stdout",
184 G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
185 G_PARAM_STATIC_STRINGS));
186 g_object_class_install_property (gobject_class, PROP_CAN_ACTIVATE_PUSH,
187 g_param_spec_boolean ("can-activate-push", "Can activate push",
188 "Can activate in push mode", DEFAULT_CAN_ACTIVATE_PUSH,
189 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
190 g_object_class_install_property (gobject_class, PROP_CAN_ACTIVATE_PULL,
191 g_param_spec_boolean ("can-activate-pull", "Can activate pull",
192 "Can activate in pull mode", DEFAULT_CAN_ACTIVATE_PULL,
193 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
194 g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS,
195 g_param_spec_int ("num-buffers", "num-buffers",
196 "Number of buffers to accept going EOS", -1, G_MAXINT,
197 DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
200 * GstFakeSink::handoff:
201 * @fakesink: the fakesink instance
202 * @buffer: the buffer that just has been received
203 * @pad: the pad that received it
205 * This signal gets emitted before unreffing the buffer.
207 gst_fake_sink_signals[SIGNAL_HANDOFF] =
208 g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
209 G_STRUCT_OFFSET (GstFakeSinkClass, handoff), NULL, NULL,
210 g_cclosure_marshal_generic, G_TYPE_NONE, 2,
211 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
214 * GstFakeSink::preroll-handoff:
215 * @fakesink: the fakesink instance
216 * @buffer: the buffer that just has been received
217 * @pad: the pad that received it
219 * This signal gets emitted before unreffing the buffer.
221 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF] =
222 g_signal_new ("preroll-handoff", G_TYPE_FROM_CLASS (klass),
223 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstFakeSinkClass, preroll_handoff),
224 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
225 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
227 gst_element_class_set_static_metadata (gstelement_class,
230 "Black hole for data",
231 "Erik Walthinsen <omega@cse.ogi.edu>, "
232 "Wim Taymans <wim@fluendo.com>, "
233 "Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com>");
235 gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
237 gstelement_class->change_state =
238 GST_DEBUG_FUNCPTR (gst_fake_sink_change_state);
240 gstbase_sink_class->event = GST_DEBUG_FUNCPTR (gst_fake_sink_event);
241 gstbase_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_fake_sink_preroll);
242 gstbase_sink_class->render = GST_DEBUG_FUNCPTR (gst_fake_sink_render);
243 gstbase_sink_class->query = GST_DEBUG_FUNCPTR (gst_fake_sink_query);
247 gst_fake_sink_init (GstFakeSink * fakesink)
249 fakesink->silent = DEFAULT_SILENT;
250 fakesink->dump = DEFAULT_DUMP;
251 fakesink->last_message = g_strdup (DEFAULT_LAST_MESSAGE);
252 fakesink->state_error = DEFAULT_STATE_ERROR;
253 fakesink->signal_handoffs = DEFAULT_SIGNAL_HANDOFFS;
254 fakesink->num_buffers = DEFAULT_NUM_BUFFERS;
256 gst_base_sink_set_sync (GST_BASE_SINK (fakesink), DEFAULT_SYNC);
257 gst_base_sink_set_drop_out_of_segment (GST_BASE_SINK (fakesink),
258 DEFAULT_DROP_OUT_OF_SEGMENT);
262 gst_fake_sink_finalize (GObject * obj)
264 G_OBJECT_CLASS (parent_class)->finalize (obj);
268 gst_fake_sink_set_property (GObject * object, guint prop_id,
269 const GValue * value, GParamSpec * pspec)
273 sink = GST_FAKE_SINK (object);
276 case PROP_STATE_ERROR:
277 sink->state_error = (GstFakeSinkStateError) g_value_get_enum (value);
280 sink->silent = g_value_get_boolean (value);
283 sink->dump = g_value_get_boolean (value);
285 case PROP_SIGNAL_HANDOFFS:
286 sink->signal_handoffs = g_value_get_boolean (value);
288 case PROP_DROP_OUT_OF_SEGMENT:
289 gst_base_sink_set_drop_out_of_segment (GST_BASE_SINK (object),
290 g_value_get_boolean (value));
292 case PROP_CAN_ACTIVATE_PUSH:
293 GST_BASE_SINK (sink)->can_activate_push = g_value_get_boolean (value);
295 case PROP_CAN_ACTIVATE_PULL:
296 GST_BASE_SINK (sink)->can_activate_pull = g_value_get_boolean (value);
298 case PROP_NUM_BUFFERS:
299 sink->num_buffers = g_value_get_int (value);
302 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
308 gst_fake_sink_get_property (GObject * object, guint prop_id, GValue * value,
313 sink = GST_FAKE_SINK (object);
316 case PROP_STATE_ERROR:
317 g_value_set_enum (value, sink->state_error);
320 g_value_set_boolean (value, sink->silent);
323 g_value_set_boolean (value, sink->dump);
325 case PROP_SIGNAL_HANDOFFS:
326 g_value_set_boolean (value, sink->signal_handoffs);
328 case PROP_DROP_OUT_OF_SEGMENT:
329 g_value_set_boolean (value,
330 gst_base_sink_get_drop_out_of_segment (GST_BASE_SINK (object)));
332 case PROP_LAST_MESSAGE:
333 GST_OBJECT_LOCK (sink);
334 g_value_set_string (value, sink->last_message);
335 GST_OBJECT_UNLOCK (sink);
337 case PROP_CAN_ACTIVATE_PUSH:
338 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_push);
340 case PROP_CAN_ACTIVATE_PULL:
341 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_pull);
343 case PROP_NUM_BUFFERS:
344 g_value_set_int (value, sink->num_buffers);
347 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
353 gst_fake_sink_notify_last_message (GstFakeSink * sink)
355 g_object_notify_by_pspec ((GObject *) sink, pspec_last_message);
359 gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event)
361 GstFakeSink *sink = GST_FAKE_SINK (bsink);
364 const GstStructure *s;
368 GST_OBJECT_LOCK (sink);
369 g_free (sink->last_message);
371 if (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE) {
373 const GstStructure *structure;
375 gst_event_parse_sink_message (event, &msg);
376 structure = gst_message_get_structure (msg);
377 sstr = gst_structure_to_string (structure);
379 g_strdup_printf ("message ******* (%s:%s) M (type: %d, %s) %p",
380 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
381 GST_MESSAGE_TYPE (msg), sstr, msg);
382 gst_message_unref (msg);
384 tstr = gst_event_type_get_name (GST_EVENT_TYPE (event));
386 if ((s = gst_event_get_structure (event))) {
387 sstr = gst_structure_to_string (s);
389 sstr = g_strdup ("");
393 g_strdup_printf ("event ******* (%s:%s) E (type: %s (%d), %s) %p",
394 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
395 tstr, GST_EVENT_TYPE (event), sstr, event);
398 GST_OBJECT_UNLOCK (sink);
400 gst_fake_sink_notify_last_message (sink);
403 return GST_BASE_SINK_CLASS (parent_class)->event (bsink, event);
407 gst_fake_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
409 GstFakeSink *sink = GST_FAKE_SINK (bsink);
411 if (sink->num_buffers_left == 0)
415 GST_OBJECT_LOCK (sink);
416 g_free (sink->last_message);
418 sink->last_message = g_strdup_printf ("preroll ******* ");
419 GST_OBJECT_UNLOCK (sink);
421 gst_fake_sink_notify_last_message (sink);
423 if (sink->signal_handoffs) {
425 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF], 0, buffer,
433 GST_DEBUG_OBJECT (sink, "we are EOS");
439 gst_fake_sink_render (GstBaseSink * bsink, GstBuffer * buf)
441 GstFakeSink *sink = GST_FAKE_SINK_CAST (bsink);
443 if (sink->num_buffers_left == 0)
446 if (sink->num_buffers_left != -1)
447 sink->num_buffers_left--;
450 gchar dts_str[64], pts_str[64], dur_str[64];
451 gchar *flag_str, *meta_str;
453 GST_OBJECT_LOCK (sink);
454 g_free (sink->last_message);
456 if (GST_BUFFER_DTS (buf) != GST_CLOCK_TIME_NONE) {
457 g_snprintf (dts_str, sizeof (dts_str), "%" GST_TIME_FORMAT,
458 GST_TIME_ARGS (GST_BUFFER_DTS (buf)));
460 g_strlcpy (dts_str, "none", sizeof (dts_str));
463 if (GST_BUFFER_PTS (buf) != GST_CLOCK_TIME_NONE) {
464 g_snprintf (pts_str, sizeof (pts_str), "%" GST_TIME_FORMAT,
465 GST_TIME_ARGS (GST_BUFFER_PTS (buf)));
467 g_strlcpy (pts_str, "none", sizeof (pts_str));
470 if (GST_BUFFER_DURATION (buf) != GST_CLOCK_TIME_NONE) {
471 g_snprintf (dur_str, sizeof (dur_str), "%" GST_TIME_FORMAT,
472 GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
474 g_strlcpy (dur_str, "none", sizeof (dur_str));
477 flag_str = gst_buffer_get_flags_string (buf);
478 meta_str = gst_buffer_get_meta_string (buf);
481 g_strdup_printf ("chain ******* (%s:%s) (%u bytes, dts: %s, pts: %s"
482 ", duration: %s, offset: %" G_GINT64_FORMAT ", offset_end: %"
483 G_GINT64_FORMAT ", flags: %08x %s, meta: %s) %p",
484 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
485 (guint) gst_buffer_get_size (buf), dts_str, pts_str,
486 dur_str, GST_BUFFER_OFFSET (buf), GST_BUFFER_OFFSET_END (buf),
487 GST_MINI_OBJECT_CAST (buf)->flags, flag_str,
488 meta_str ? meta_str : "none", buf);
491 GST_OBJECT_UNLOCK (sink);
493 gst_fake_sink_notify_last_message (sink);
495 if (sink->signal_handoffs)
496 g_signal_emit (sink, gst_fake_sink_signals[SIGNAL_HANDOFF], 0, buf,
502 if (gst_buffer_map (buf, &info, GST_MAP_READ)) {
503 gst_util_dump_mem (info.data, info.size);
504 gst_buffer_unmap (buf, &info);
507 if (sink->num_buffers_left == 0)
515 GST_DEBUG_OBJECT (sink, "we are EOS");
521 gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query)
525 switch (GST_QUERY_TYPE (query)) {
526 case GST_QUERY_SEEKING:{
529 /* we don't supporting seeking */
530 gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
531 gst_query_set_seeking (query, fmt, FALSE, 0, -1);
536 ret = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
543 static GstStateChangeReturn
544 gst_fake_sink_change_state (GstElement * element, GstStateChange transition)
546 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
547 GstFakeSink *fakesink = GST_FAKE_SINK (element);
549 switch (transition) {
550 case GST_STATE_CHANGE_NULL_TO_READY:
551 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_NULL_READY)
554 case GST_STATE_CHANGE_READY_TO_PAUSED:
555 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_PAUSED)
557 fakesink->num_buffers_left = fakesink->num_buffers;
559 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
560 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_PLAYING)
567 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
569 switch (transition) {
570 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
571 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PLAYING_PAUSED)
574 case GST_STATE_CHANGE_PAUSED_TO_READY:
575 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_READY)
578 case GST_STATE_CHANGE_READY_TO_NULL:
579 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_NULL)
581 GST_OBJECT_LOCK (fakesink);
582 g_free (fakesink->last_message);
583 fakesink->last_message = NULL;
584 GST_OBJECT_UNLOCK (fakesink);
594 GST_ELEMENT_ERROR (element, CORE, STATE_CHANGE, (NULL),
595 ("Erroring out on state change as requested"));
596 return GST_STATE_CHANGE_FAILURE;