gst/check/consistencychecker: Check type of miniobject in probe
[glsdk/gstreamer0-10.git] / libs / gst / check / gstconsistencychecker.c
1 /* GStreamer
2  *
3  * unit testing helper lib
4  *
5  * Copyright (C) 2009 Edward Hervey <bilboed@bilboed.com>
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  */
23 /**
24  * SECTION:gstcheckconsistencychecker
25  * @short_description: Data flow consistency checker for GStreamer unit tests.
26  *
27  * These macros and functions are for internal use of the unit tests found
28  * inside the 'check' directories of various GStreamer packages.
29  *
30  * Since: 0.10.24
31  */
33 #include "gstconsistencychecker.h"
35 struct _GstStreamConsistency
36 {
37   gboolean flushing;
38   gboolean newsegment;
39   gboolean eos;
40   gulong probeid;
41   GstPad *pad;
42 };
44 static gboolean
45 source_pad_data_cb (GstPad * pad, GstMiniObject * data,
46     GstStreamConsistency * consist)
47 {
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 newsegment event */
54     fail_unless (consist->newsegment, "Buffer received without newsegment");
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;
62         break;
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;
69         break;
70       case GST_EVENT_NEWSEGMENT:
71         consist->newsegment = TRUE;
72         consist->eos = FALSE;
73         break;
74       case GST_EVENT_EOS:
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");
77         consist->eos = TRUE;
78         consist->newsegment = FALSE;
79         break;
80       case GST_EVENT_TAG:
81         GST_DEBUG_OBJECT (pad, "tag %" GST_PTR_FORMAT, event->structure);
82       default:
83         if (GST_EVENT_IS_SERIALIZED (event) && GST_EVENT_IS_DOWNSTREAM (event)) {
84           fail_if (consist->eos, "Event received after EOS");
85           fail_unless (consist->newsegment, "Event received before newsegment");
86         }
87         /* FIXME : Figure out what to do for other events */
88         break;
89     }
90   }
92   return TRUE;
93 }
95 /**
96  * gst_consistency_checker_new:
97  * @pad: The #GstPad on which the dataflow will be checked.
98  *
99  * Sets up a data probe on the given pad which will raise assertions if the
100  * data flow is inconsistent.
101  *
102  * Currently only works for source pads.
103  *
104  * Returns: A #GstStreamConsistency structure used to track data flow.
105  *
106  * Since: 0.10.24
107  */
109 GstStreamConsistency *
110 gst_consistency_checker_new (GstPad * pad)
112   GstStreamConsistency *consist;
114   g_return_val_if_fail (pad != NULL, NULL);
116   consist = g_new0 (GstStreamConsistency, 1);
117   consist->pad = g_object_ref (pad);
118   consist->probeid =
119       gst_pad_add_data_probe (pad, (GCallback) source_pad_data_cb, consist);
121   return consist;
124 /**
125  * gst_consistency_checker_reset:
126  * @consist: The #GstStreamConsistency to reset.
127  *
128  * Reset the stream checker's internal variables.
129  *
130  * Since: 0.10.24
131  */
133 void
134 gst_consistency_checker_reset (GstStreamConsistency * consist)
136   consist->eos = FALSE;
137   consist->flushing = FALSE;
138   consist->newsegment = FALSE;
141 /**
142  * gst_consistency_checker_free:
143  * @consist: The #GstStreamConsistency to free.
144  *
145  * Frees the allocated data and probe associated with @consist.
146  *
147  * Since: 0.10.24
148  */
150 void
151 gst_consistency_checker_free (GstStreamConsistency * consist)
153   /* Remove the data probe */
154   gst_pad_remove_data_probe (consist->pad, consist->probeid);
155   g_object_unref (consist->pad);
156   g_free (consist);