3 * unit testing helper lib
5 * Copyright (C) 2009 Edward Hervey <bilboed@bilboed.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.
24 * SECTION:gstcheckconsistencychecker
25 * @short_description: Data flow consistency checker for GStreamer unit tests.
27 * These macros and functions are for internal use of the unit tests found
28 * inside the 'check' directories of various GStreamer packages.
33 #include "gstconsistencychecker.h"
35 struct _GstStreamConsistency
45 source_pad_data_cb (GstPad * pad, GstProbeType type, GstMiniObject * data,
46 GstStreamConsistency * consist)
48 if (GST_IS_BUFFER (data)) {
49 GST_DEBUG_OBJECT (pad, "Buffer %" GST_TIME_FORMAT,
50 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (GST_BUFFER (data))));
51 /* If an EOS went through, a buffer would be invalid */
52 fail_if (consist->eos, "Buffer received after EOS");
53 /* Buffers need to be preceded by a segment event */
54 fail_unless (consist->segment, "Buffer received without segment");
55 } else if (GST_IS_EVENT (data)) {
56 GstEvent *event = (GstEvent *) data;
58 GST_DEBUG_OBJECT (pad, "%s", GST_EVENT_TYPE_NAME (event));
59 switch (GST_EVENT_TYPE (event)) {
60 case GST_EVENT_FLUSH_START:
61 consist->flushing = TRUE;
63 case GST_EVENT_FLUSH_STOP:
64 /* Receiving a flush-stop is only valid after receiving a flush-start */
65 fail_unless (consist->flushing,
66 "Received a FLUSH_STOP without a FLUSH_START");
67 fail_if (consist->eos, "Received a FLUSH_STOP after an EOS");
68 consist->flushing = FALSE;
70 case GST_EVENT_SEGMENT:
71 consist->segment = TRUE;
75 /* FIXME : not 100% sure about whether two eos in a row is valid */
76 fail_if (consist->eos, "Received EOS just after another EOS");
78 consist->segment = FALSE;
81 GST_DEBUG_OBJECT (pad, "tag %" GST_PTR_FORMAT,
82 gst_event_get_structure (event));
85 if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_IS_DOWNSTREAM (event)) {
86 fail_if (consist->eos, "Event received after EOS");
87 fail_unless (consist->segment, "Event received before segment");
89 /* FIXME : Figure out what to do for other events */
98 * gst_consistency_checker_new:
99 * @pad: The #GstPad on which the dataflow will be checked.
101 * Sets up a data probe on the given pad which will raise assertions if the
102 * data flow is inconsistent.
104 * Currently only works for source pads.
106 * Returns: A #GstStreamConsistency structure used to track data flow.
111 GstStreamConsistency *
112 gst_consistency_checker_new (GstPad * pad)
114 GstStreamConsistency *consist;
116 g_return_val_if_fail (pad != NULL, NULL);
118 consist = g_new0 (GstStreamConsistency, 1);
119 consist->pad = g_object_ref (pad);
121 gst_pad_add_probe (pad, GST_PROBE_TYPE_DATA,
122 (GstPadProbeCallback) source_pad_data_cb, consist, NULL);
128 * gst_consistency_checker_reset:
129 * @consist: The #GstStreamConsistency to reset.
131 * Reset the stream checker's internal variables.
137 gst_consistency_checker_reset (GstStreamConsistency * consist)
139 consist->eos = FALSE;
140 consist->flushing = FALSE;
141 consist->segment = FALSE;
145 * gst_consistency_checker_free:
146 * @consist: The #GstStreamConsistency to free.
148 * Frees the allocated data and probe associated with @consist.
154 gst_consistency_checker_free (GstStreamConsistency * consist)
156 /* Remove the data probe */
157 gst_pad_remove_probe (consist->pad, consist->probeid);
158 g_object_unref (consist->pad);