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
63 #define DEFAULT_STATE_ERROR FAKE_SINK_STATE_ERROR_NONE
64 #define DEFAULT_SILENT TRUE
65 #define DEFAULT_DUMP FALSE
66 #define DEFAULT_SIGNAL_HANDOFFS FALSE
67 #define DEFAULT_LAST_MESSAGE NULL
68 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
69 #define DEFAULT_CAN_ACTIVATE_PULL FALSE
70 #define DEFAULT_NUM_BUFFERS -1
80 PROP_CAN_ACTIVATE_PUSH,
81 PROP_CAN_ACTIVATE_PULL,
85 #define GST_TYPE_FAKE_SINK_STATE_ERROR (gst_fake_sink_state_error_get_type())
87 gst_fake_sink_state_error_get_type (void)
89 static GType fakesink_state_error_type = 0;
90 static const GEnumValue fakesink_state_error[] = {
91 {FAKE_SINK_STATE_ERROR_NONE, "No state change errors", "none"},
92 {FAKE_SINK_STATE_ERROR_NULL_READY,
93 "Fail state change from NULL to READY", "null-to-ready"},
94 {FAKE_SINK_STATE_ERROR_READY_PAUSED,
95 "Fail state change from READY to PAUSED", "ready-to-paused"},
96 {FAKE_SINK_STATE_ERROR_PAUSED_PLAYING,
97 "Fail state change from PAUSED to PLAYING", "paused-to-playing"},
98 {FAKE_SINK_STATE_ERROR_PLAYING_PAUSED,
99 "Fail state change from PLAYING to PAUSED", "playing-to-paused"},
100 {FAKE_SINK_STATE_ERROR_PAUSED_READY,
101 "Fail state change from PAUSED to READY", "paused-to-ready"},
102 {FAKE_SINK_STATE_ERROR_READY_NULL,
103 "Fail state change from READY to NULL", "ready-to-null"},
107 if (!fakesink_state_error_type) {
108 fakesink_state_error_type =
109 g_enum_register_static ("GstFakeSinkStateError", fakesink_state_error);
111 return fakesink_state_error_type;
115 GST_DEBUG_CATEGORY_INIT (gst_fake_sink_debug, "fakesink", 0, "fakesink element");
116 #define gst_fake_sink_parent_class parent_class
117 G_DEFINE_TYPE_WITH_CODE (GstFakeSink, gst_fake_sink, GST_TYPE_BASE_SINK,
120 static void gst_fake_sink_set_property (GObject * object, guint prop_id,
121 const GValue * value, GParamSpec * pspec);
122 static void gst_fake_sink_get_property (GObject * object, guint prop_id,
123 GValue * value, GParamSpec * pspec);
124 static void gst_fake_sink_finalize (GObject * obj);
126 static GstStateChangeReturn gst_fake_sink_change_state (GstElement * element,
127 GstStateChange transition);
129 static GstFlowReturn gst_fake_sink_preroll (GstBaseSink * bsink,
131 static GstFlowReturn gst_fake_sink_render (GstBaseSink * bsink,
133 static gboolean gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event);
134 static gboolean gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query);
136 static guint gst_fake_sink_signals[LAST_SIGNAL] = { 0 };
138 static GParamSpec *pspec_last_message = NULL;
141 gst_fake_sink_class_init (GstFakeSinkClass * klass)
143 GObjectClass *gobject_class;
144 GstElementClass *gstelement_class;
145 GstBaseSinkClass *gstbase_sink_class;
147 gobject_class = G_OBJECT_CLASS (klass);
148 gstelement_class = GST_ELEMENT_CLASS (klass);
149 gstbase_sink_class = GST_BASE_SINK_CLASS (klass);
151 gobject_class->set_property = gst_fake_sink_set_property;
152 gobject_class->get_property = gst_fake_sink_get_property;
153 gobject_class->finalize = gst_fake_sink_finalize;
155 g_object_class_install_property (gobject_class, PROP_STATE_ERROR,
156 g_param_spec_enum ("state-error", "State Error",
157 "Generate a state change error", GST_TYPE_FAKE_SINK_STATE_ERROR,
158 DEFAULT_STATE_ERROR, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
159 pspec_last_message = g_param_spec_string ("last-message", "Last Message",
160 "The message describing current status", DEFAULT_LAST_MESSAGE,
161 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
162 g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
164 g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
165 g_param_spec_boolean ("signal-handoffs", "Signal handoffs",
166 "Send a signal before unreffing the buffer", DEFAULT_SIGNAL_HANDOFFS,
167 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
168 g_object_class_install_property (gobject_class, PROP_SILENT,
169 g_param_spec_boolean ("silent", "Silent",
170 "Don't produce last_message events", DEFAULT_SILENT,
171 G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
172 G_PARAM_STATIC_STRINGS));
173 g_object_class_install_property (gobject_class, PROP_DUMP,
174 g_param_spec_boolean ("dump", "Dump", "Dump buffer contents to stdout",
175 DEFAULT_DUMP, G_PARAM_READWRITE | GST_PARAM_MUTABLE_PLAYING |
176 G_PARAM_STATIC_STRINGS));
177 g_object_class_install_property (gobject_class,
178 PROP_CAN_ACTIVATE_PUSH,
179 g_param_spec_boolean ("can-activate-push", "Can activate push",
180 "Can activate in push mode", DEFAULT_CAN_ACTIVATE_PUSH,
181 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
182 g_object_class_install_property (gobject_class,
183 PROP_CAN_ACTIVATE_PULL,
184 g_param_spec_boolean ("can-activate-pull", "Can activate pull",
185 "Can activate in pull mode", DEFAULT_CAN_ACTIVATE_PULL,
186 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
187 g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS,
188 g_param_spec_int ("num-buffers", "num-buffers",
189 "Number of buffers to accept going EOS", -1, G_MAXINT,
190 DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
193 * GstFakeSink::handoff:
194 * @fakesink: the fakesink instance
195 * @buffer: the buffer that just has been received
196 * @pad: the pad that received it
198 * This signal gets emitted before unreffing the buffer.
200 gst_fake_sink_signals[SIGNAL_HANDOFF] =
201 g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
202 G_STRUCT_OFFSET (GstFakeSinkClass, handoff), NULL, NULL,
203 g_cclosure_marshal_generic, G_TYPE_NONE, 2,
204 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
207 * GstFakeSink::preroll-handoff:
208 * @fakesink: the fakesink instance
209 * @buffer: the buffer that just has been received
210 * @pad: the pad that received it
212 * This signal gets emitted before unreffing the buffer.
214 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF] =
215 g_signal_new ("preroll-handoff", G_TYPE_FROM_CLASS (klass),
216 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstFakeSinkClass, preroll_handoff),
217 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
218 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, GST_TYPE_PAD);
220 gst_element_class_set_static_metadata (gstelement_class,
223 "Black hole for data",
224 "Erik Walthinsen <omega@cse.ogi.edu>, "
225 "Wim Taymans <wim@fluendo.com>, "
226 "Mr. 'frag-me-more' Vanderwingo <wingo@fluendo.com>");
228 gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
230 gstelement_class->change_state =
231 GST_DEBUG_FUNCPTR (gst_fake_sink_change_state);
233 gstbase_sink_class->event = GST_DEBUG_FUNCPTR (gst_fake_sink_event);
234 gstbase_sink_class->preroll = GST_DEBUG_FUNCPTR (gst_fake_sink_preroll);
235 gstbase_sink_class->render = GST_DEBUG_FUNCPTR (gst_fake_sink_render);
236 gstbase_sink_class->query = GST_DEBUG_FUNCPTR (gst_fake_sink_query);
240 gst_fake_sink_init (GstFakeSink * fakesink)
242 fakesink->silent = DEFAULT_SILENT;
243 fakesink->dump = DEFAULT_DUMP;
244 fakesink->last_message = g_strdup (DEFAULT_LAST_MESSAGE);
245 fakesink->state_error = DEFAULT_STATE_ERROR;
246 fakesink->signal_handoffs = DEFAULT_SIGNAL_HANDOFFS;
247 fakesink->num_buffers = DEFAULT_NUM_BUFFERS;
249 gst_base_sink_set_sync (GST_BASE_SINK (fakesink), DEFAULT_SYNC);
253 gst_fake_sink_finalize (GObject * obj)
255 G_OBJECT_CLASS (parent_class)->finalize (obj);
259 gst_fake_sink_set_property (GObject * object, guint prop_id,
260 const GValue * value, GParamSpec * pspec)
264 sink = GST_FAKE_SINK (object);
267 case PROP_STATE_ERROR:
268 sink->state_error = (GstFakeSinkStateError) g_value_get_enum (value);
271 sink->silent = g_value_get_boolean (value);
274 sink->dump = g_value_get_boolean (value);
276 case PROP_SIGNAL_HANDOFFS:
277 sink->signal_handoffs = g_value_get_boolean (value);
279 case PROP_CAN_ACTIVATE_PUSH:
280 GST_BASE_SINK (sink)->can_activate_push = g_value_get_boolean (value);
282 case PROP_CAN_ACTIVATE_PULL:
283 GST_BASE_SINK (sink)->can_activate_pull = g_value_get_boolean (value);
285 case PROP_NUM_BUFFERS:
286 sink->num_buffers = g_value_get_int (value);
289 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
295 gst_fake_sink_get_property (GObject * object, guint prop_id, GValue * value,
300 sink = GST_FAKE_SINK (object);
303 case PROP_STATE_ERROR:
304 g_value_set_enum (value, sink->state_error);
307 g_value_set_boolean (value, sink->silent);
310 g_value_set_boolean (value, sink->dump);
312 case PROP_SIGNAL_HANDOFFS:
313 g_value_set_boolean (value, sink->signal_handoffs);
315 case PROP_LAST_MESSAGE:
316 GST_OBJECT_LOCK (sink);
317 g_value_set_string (value, sink->last_message);
318 GST_OBJECT_UNLOCK (sink);
320 case PROP_CAN_ACTIVATE_PUSH:
321 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_push);
323 case PROP_CAN_ACTIVATE_PULL:
324 g_value_set_boolean (value, GST_BASE_SINK (sink)->can_activate_pull);
326 case PROP_NUM_BUFFERS:
327 g_value_set_int (value, sink->num_buffers);
330 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
336 gst_fake_sink_notify_last_message (GstFakeSink * sink)
338 g_object_notify_by_pspec ((GObject *) sink, pspec_last_message);
342 gst_fake_sink_event (GstBaseSink * bsink, GstEvent * event)
344 GstFakeSink *sink = GST_FAKE_SINK (bsink);
347 const GstStructure *s;
351 GST_OBJECT_LOCK (sink);
352 g_free (sink->last_message);
354 if (GST_EVENT_TYPE (event) == GST_EVENT_SINK_MESSAGE) {
356 const GstStructure *structure;
358 gst_event_parse_sink_message (event, &msg);
359 structure = gst_message_get_structure (msg);
360 sstr = gst_structure_to_string (structure);
362 g_strdup_printf ("message ******* (%s:%s) M (type: %d, %s) %p",
363 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
364 GST_MESSAGE_TYPE (msg), sstr, msg);
365 gst_message_unref (msg);
367 tstr = gst_event_type_get_name (GST_EVENT_TYPE (event));
369 if ((s = gst_event_get_structure (event))) {
370 sstr = gst_structure_to_string (s);
372 sstr = g_strdup ("");
376 g_strdup_printf ("event ******* (%s:%s) E (type: %s (%d), %s) %p",
377 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
378 tstr, GST_EVENT_TYPE (event), sstr, event);
381 GST_OBJECT_UNLOCK (sink);
383 gst_fake_sink_notify_last_message (sink);
386 return GST_BASE_SINK_CLASS (parent_class)->event (bsink, event);
390 gst_fake_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
392 GstFakeSink *sink = GST_FAKE_SINK (bsink);
394 if (sink->num_buffers_left == 0)
398 GST_OBJECT_LOCK (sink);
399 g_free (sink->last_message);
401 sink->last_message = g_strdup_printf ("preroll ******* ");
402 GST_OBJECT_UNLOCK (sink);
404 gst_fake_sink_notify_last_message (sink);
406 if (sink->signal_handoffs) {
408 gst_fake_sink_signals[SIGNAL_PREROLL_HANDOFF], 0, buffer,
416 GST_DEBUG_OBJECT (sink, "we are EOS");
422 gst_fake_sink_render (GstBaseSink * bsink, GstBuffer * buf)
424 GstFakeSink *sink = GST_FAKE_SINK_CAST (bsink);
426 if (sink->num_buffers_left == 0)
429 if (sink->num_buffers_left != -1)
430 sink->num_buffers_left--;
433 gchar dts_str[64], pts_str[64], dur_str[64];
436 GST_OBJECT_LOCK (sink);
437 g_free (sink->last_message);
439 if (GST_BUFFER_DTS (buf) != GST_CLOCK_TIME_NONE) {
440 g_snprintf (dts_str, sizeof (dts_str), "%" GST_TIME_FORMAT,
441 GST_TIME_ARGS (GST_BUFFER_DTS (buf)));
443 g_strlcpy (dts_str, "none", sizeof (dts_str));
446 if (GST_BUFFER_PTS (buf) != GST_CLOCK_TIME_NONE) {
447 g_snprintf (pts_str, sizeof (pts_str), "%" GST_TIME_FORMAT,
448 GST_TIME_ARGS (GST_BUFFER_PTS (buf)));
450 g_strlcpy (pts_str, "none", sizeof (pts_str));
453 if (GST_BUFFER_DURATION (buf) != GST_CLOCK_TIME_NONE) {
454 g_snprintf (dur_str, sizeof (dur_str), "%" GST_TIME_FORMAT,
455 GST_TIME_ARGS (GST_BUFFER_DURATION (buf)));
457 g_strlcpy (dur_str, "none", sizeof (dur_str));
460 flag_str = gst_buffer_get_flags_string (buf);
463 g_strdup_printf ("chain ******* (%s:%s) (%u bytes, dts: %s, pts: %s"
464 ", duration: %s, offset: %" G_GINT64_FORMAT ", offset_end: %"
465 G_GINT64_FORMAT ", flags: %08x %s) %p",
466 GST_DEBUG_PAD_NAME (GST_BASE_SINK_CAST (sink)->sinkpad),
467 (guint) gst_buffer_get_size (buf), dts_str, pts_str,
468 dur_str, GST_BUFFER_OFFSET (buf), GST_BUFFER_OFFSET_END (buf),
469 GST_MINI_OBJECT_CAST (buf)->flags, flag_str, buf);
471 GST_OBJECT_UNLOCK (sink);
473 gst_fake_sink_notify_last_message (sink);
475 if (sink->signal_handoffs)
476 g_signal_emit (sink, gst_fake_sink_signals[SIGNAL_HANDOFF], 0, buf,
482 if (gst_buffer_map (buf, &info, GST_MAP_READ)) {
483 gst_util_dump_mem (info.data, info.size);
484 gst_buffer_unmap (buf, &info);
487 if (sink->num_buffers_left == 0)
495 GST_DEBUG_OBJECT (sink, "we are EOS");
501 gst_fake_sink_query (GstBaseSink * bsink, GstQuery * query)
505 switch (GST_QUERY_TYPE (query)) {
506 case GST_QUERY_SEEKING:{
509 /* we don't supporting seeking */
510 gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
511 gst_query_set_seeking (query, fmt, FALSE, 0, -1);
516 ret = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
523 static GstStateChangeReturn
524 gst_fake_sink_change_state (GstElement * element, GstStateChange transition)
526 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
527 GstFakeSink *fakesink = GST_FAKE_SINK (element);
529 switch (transition) {
530 case GST_STATE_CHANGE_NULL_TO_READY:
531 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_NULL_READY)
534 case GST_STATE_CHANGE_READY_TO_PAUSED:
535 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_PAUSED)
537 fakesink->num_buffers_left = fakesink->num_buffers;
539 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
540 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_PLAYING)
547 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
549 switch (transition) {
550 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
551 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PLAYING_PAUSED)
554 case GST_STATE_CHANGE_PAUSED_TO_READY:
555 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_PAUSED_READY)
558 case GST_STATE_CHANGE_READY_TO_NULL:
559 if (fakesink->state_error == FAKE_SINK_STATE_ERROR_READY_NULL)
561 GST_OBJECT_LOCK (fakesink);
562 g_free (fakesink->last_message);
563 fakesink->last_message = NULL;
564 GST_OBJECT_UNLOCK (fakesink);
574 GST_ELEMENT_ERROR (element, CORE, STATE_CHANGE, (NULL),
575 ("Erroring out on state change as requested"));
576 return GST_STATE_CHANGE_FAILURE;