Imported Upstream version 0.10.36
[profile/ivi/gstreamer.git] / docs / libs / html / gstreamer-libs-GstCheck.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GstCheck</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer 0.10 Library Reference Manual">
8 <link rel="up" href="gstreamer-check.html" title="GStreamer Check Unit Testing">
9 <link rel="prev" href="gstreamer-check.html" title="GStreamer Check Unit Testing">
10 <link rel="next" href="gstreamer-libs-GstBufferStraw.html" title="GstBufferStraw">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="gstreamer-check.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gstreamer-check.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GStreamer 0.10 Library Reference Manual</th>
21 <td><a accesskey="n" href="gstreamer-libs-GstBufferStraw.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gstreamer-libs-GstCheck.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gstreamer-libs-GstCheck.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gstreamer-libs-GstCheck"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gstreamer-libs-GstCheck.top_of_page"></a>GstCheck</span></h2>
34 <p>GstCheck — Common code for GStreamer unit tests</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gstreamer-libs-GstCheck.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;gst/check/gstcheck.h&gt;
42
43 #define             <a class="link" href="gstreamer-libs-GstCheck.html#GST-START-TEST:CAPS" title="GST_START_TEST()">GST_START_TEST</a>                      (__testname)
44 #define             <a class="link" href="gstreamer-libs-GstCheck.html#GST-END-TEST:CAPS" title="GST_END_TEST">GST_END_TEST</a>
45 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-BUFFER-REFCOUNT:CAPS" title="ASSERT_BUFFER_REFCOUNT()">ASSERT_BUFFER_REFCOUNT</a>              (buffer,
46                                                          name,
47                                                          value)
48 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-CAPS-REFCOUNT:CAPS" title="ASSERT_CAPS_REFCOUNT()">ASSERT_CAPS_REFCOUNT</a>                (caps,
49                                                          name,
50                                                          value)
51 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-CRITICAL:CAPS" title="ASSERT_CRITICAL()">ASSERT_CRITICAL</a>                     (code)
52 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-WARNING:CAPS" title="ASSERT_WARNING()">ASSERT_WARNING</a>                      (code)
53 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-MINI-OBJECT-REFCOUNT:CAPS" title="ASSERT_MINI_OBJECT_REFCOUNT()">ASSERT_MINI_OBJECT_REFCOUNT</a>         (caps,
54                                                          name,
55                                                          value)
56 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-OBJECT-REFCOUNT:CAPS" title="ASSERT_OBJECT_REFCOUNT()">ASSERT_OBJECT_REFCOUNT</a>              (object,
57                                                          name,
58                                                          value)
59 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-OBJECT-REFCOUNT-BETWEEN:CAPS" title="ASSERT_OBJECT_REFCOUNT_BETWEEN()">ASSERT_OBJECT_REFCOUNT_BETWEEN</a>      (object,
60                                                          name,
61                                                          lower,
62                                                          upper)
63 #define             <a class="link" href="gstreamer-libs-GstCheck.html#ASSERT-SET-STATE:CAPS" title="ASSERT_SET_STATE()">ASSERT_SET_STATE</a>                    (element,
64                                                          state,
65                                                          ret)
66 #define             <a class="link" href="gstreamer-libs-GstCheck.html#fail-unless-equals-int" title="fail_unless_equals_int()">fail_unless_equals_int</a>              (a,
67                                                          b)
68 #define             <a class="link" href="gstreamer-libs-GstCheck.html#fail-unless-equals-float" title="fail_unless_equals_float()">fail_unless_equals_float</a>            (a,
69                                                          b)
70 #define             <a class="link" href="gstreamer-libs-GstCheck.html#fail-unless-equals-string" title="fail_unless_equals_string()">fail_unless_equals_string</a>           (a,
71                                                          b)
72 #define             <a class="link" href="gstreamer-libs-GstCheck.html#fail-unless-equals-uint64" title="fail_unless_equals_uint64()">fail_unless_equals_uint64</a>           (a,
73                                                          b)
74 #define             <a class="link" href="gstreamer-libs-GstCheck.html#fail-unless-message-error" title="fail_unless_message_error()">fail_unless_message_error</a>           (msg,
75                                                          domain,
76                                                          code)
77 #define             <a class="link" href="gstreamer-libs-GstCheck.html#assert-equals-int" title="assert_equals_int()">assert_equals_int</a>                   (a,
78                                                          b)
79 #define             <a class="link" href="gstreamer-libs-GstCheck.html#assert-equals-float" title="assert_equals_float()">assert_equals_float</a>                 (a,
80                                                          b)
81 #define             <a class="link" href="gstreamer-libs-GstCheck.html#assert-equals-string" title="assert_equals_string()">assert_equals_string</a>                (a,
82                                                          b)
83 #define             <a class="link" href="gstreamer-libs-GstCheck.html#assert-equals-uint64" title="assert_equals_uint64()">assert_equals_uint64</a>                (a,
84                                                          b)
85 #define             <a class="link" href="gstreamer-libs-GstCheck.html#assert-message-error" title="assert_message_error()">assert_message_error</a>                (m,
86                                                          d,
87                                                          c)
88 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-init" title="gst_check_init ()">gst_check_init</a>                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
89                                                          <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);
90 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-message-error" title="gst_check_message_error ()">gst_check_message_error</a>             (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
91                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessageType"><span class="type">GstMessageType</span></a> type</code></em>,
92                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
93                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>);
94 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="returnvalue">GstElement</span></a> *        <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-setup-element" title="gst_check_setup_element ()">gst_check_setup_element</a>             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *factory</code></em>);
95 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-setup-sink-pad" title="gst_check_setup_sink_pad ()">gst_check_setup_sink_pad</a>            (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
96                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
97                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
98 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-setup-src-pad" title="gst_check_setup_src_pad ()">gst_check_setup_src_pad</a>             (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
99                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
100                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);
101 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-setup-sink-pad-by-name" title="gst_check_setup_sink_pad_by_name ()">gst_check_setup_sink_pad_by_name</a>    (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
102                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
103                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
104 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-setup-src-pad-by-name" title="gst_check_setup_src_pad_by_name ()">gst_check_setup_src_pad_by_name</a>     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
105                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
106                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
107 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-teardown-pad-by-name" title="gst_check_teardown_pad_by_name ()">gst_check_teardown_pad_by_name</a>      (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
108                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
109 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-teardown-element" title="gst_check_teardown_element ()">gst_check_teardown_element</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);
110 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-teardown-sink-pad" title="gst_check_teardown_sink_pad ()">gst_check_teardown_sink_pad</a>         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);
111 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-teardown-src-pad" title="gst_check_teardown_src_pad ()">gst_check_teardown_src_pad</a>          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);
112 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-drop-buffers" title="gst_check_drop_buffers ()">gst_check_drop_buffers</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
113 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-caps-equal" title="gst_check_caps_equal ()">gst_check_caps_equal</a>                (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps1</code></em>,
114                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps2</code></em>);
115 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-element-push-buffer-list" title="gst_check_element_push_buffer_list ()">gst_check_element_push_buffer_list</a>  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *element_name</code></em>,
116                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *buffer_in</code></em>,
117                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *buffer_out</code></em>,
118                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a> last_flow_return</code></em>);
119 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-element-push-buffer" title="gst_check_element_push_buffer ()">gst_check_element_push_buffer</a>       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *element_name</code></em>,
120                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer_in</code></em>,
121                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer_out</code></em>);
122 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="gstreamer-libs-GstCheck.html#gst-check-run-suite" title="gst_check_run_suite ()">gst_check_run_suite</a>                 (<em class="parameter"><code><span class="type">Suite</span> *suite</code></em>,
123                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
124                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fname</code></em>);
125 </pre>
126 </div>
127 <div class="refsect1">
128 <a name="gstreamer-libs-GstCheck.description"></a><h2>Description</h2>
129 <p>
130 These macros and functions are for internal use of the unit tests found
131 inside the 'check' directories of various GStreamer packages.
132 </p>
133 </div>
134 <div class="refsect1">
135 <a name="gstreamer-libs-GstCheck.details"></a><h2>Details</h2>
136 <div class="refsect2">
137 <a name="GST-START-TEST:CAPS"></a><h3>GST_START_TEST()</h3>
138 <pre class="programlisting">#define             GST_START_TEST(__testname)</pre>
139 <p>
140 wrapper for checks START_TEST
141 </p>
142 <div class="variablelist"><table border="0">
143 <col align="left" valign="top">
144 <tbody><tr>
145 <td><p><span class="term"><em class="parameter"><code>__testname</code></em> :</span></p></td>
146 <td>test function name</td>
147 </tr></tbody>
148 </table></div>
149 </div>
150 <hr>
151 <div class="refsect2">
152 <a name="GST-END-TEST:CAPS"></a><h3>GST_END_TEST</h3>
153 <pre class="programlisting">#define             GST_END_TEST</pre>
154 <p>
155 wrapper for checks END_TEST
156 </p>
157 </div>
158 <hr>
159 <div class="refsect2">
160 <a name="ASSERT-BUFFER-REFCOUNT:CAPS"></a><h3>ASSERT_BUFFER_REFCOUNT()</h3>
161 <pre class="programlisting">#define             ASSERT_BUFFER_REFCOUNT(buffer, name, value)</pre>
162 </div>
163 <hr>
164 <div class="refsect2">
165 <a name="ASSERT-CAPS-REFCOUNT:CAPS"></a><h3>ASSERT_CAPS_REFCOUNT()</h3>
166 <pre class="programlisting">#define             ASSERT_CAPS_REFCOUNT(caps, name, value)</pre>
167 </div>
168 <hr>
169 <div class="refsect2">
170 <a name="ASSERT-CRITICAL:CAPS"></a><h3>ASSERT_CRITICAL()</h3>
171 <pre class="programlisting">#define             ASSERT_CRITICAL(code)</pre>
172 </div>
173 <hr>
174 <div class="refsect2">
175 <a name="ASSERT-WARNING:CAPS"></a><h3>ASSERT_WARNING()</h3>
176 <pre class="programlisting">#define             ASSERT_WARNING(code)</pre>
177 </div>
178 <hr>
179 <div class="refsect2">
180 <a name="ASSERT-MINI-OBJECT-REFCOUNT:CAPS"></a><h3>ASSERT_MINI_OBJECT_REFCOUNT()</h3>
181 <pre class="programlisting">#define             ASSERT_MINI_OBJECT_REFCOUNT(caps, name, value)</pre>
182 </div>
183 <hr>
184 <div class="refsect2">
185 <a name="ASSERT-OBJECT-REFCOUNT:CAPS"></a><h3>ASSERT_OBJECT_REFCOUNT()</h3>
186 <pre class="programlisting">#define             ASSERT_OBJECT_REFCOUNT(object, name, value)</pre>
187 </div>
188 <hr>
189 <div class="refsect2">
190 <a name="ASSERT-OBJECT-REFCOUNT-BETWEEN:CAPS"></a><h3>ASSERT_OBJECT_REFCOUNT_BETWEEN()</h3>
191 <pre class="programlisting">#define             ASSERT_OBJECT_REFCOUNT_BETWEEN(object, name, lower, upper)</pre>
192 </div>
193 <hr>
194 <div class="refsect2">
195 <a name="ASSERT-SET-STATE:CAPS"></a><h3>ASSERT_SET_STATE()</h3>
196 <pre class="programlisting">#define             ASSERT_SET_STATE(element, state, ret)</pre>
197 </div>
198 <hr>
199 <div class="refsect2">
200 <a name="fail-unless-equals-int"></a><h3>fail_unless_equals_int()</h3>
201 <pre class="programlisting">#define             fail_unless_equals_int(a, b)</pre>
202 <p>
203 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal and aborts if this is not the
204 case, printing both expressions and the values they evaluated to. This
205 macro is for use in unit tests.
206 </p>
207 <div class="variablelist"><table border="0">
208 <col align="left" valign="top">
209 <tbody>
210 <tr>
211 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
212 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value or expression</td>
213 </tr>
214 <tr>
215 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
216 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value or expression</td>
217 </tr>
218 </tbody>
219 </table></div>
220 </div>
221 <hr>
222 <div class="refsect2">
223 <a name="fail-unless-equals-float"></a><h3>fail_unless_equals_float()</h3>
224 <pre class="programlisting">#define             fail_unless_equals_float(a, b)</pre>
225 <p>
226 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are (almost) equal and aborts if this
227 is not the case, printing both expressions and the values they evaluated
228 to. This macro is for use in unit tests.
229 </p>
230 <div class="variablelist"><table border="0">
231 <col align="left" valign="top">
232 <tbody>
233 <tr>
234 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
235 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value or expression</td>
236 </tr>
237 <tr>
238 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
239 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value or expression</td>
240 </tr>
241 </tbody>
242 </table></div>
243 <p class="since">Since 0.10.14</p>
244 </div>
245 <hr>
246 <div class="refsect2">
247 <a name="fail-unless-equals-string"></a><h3>fail_unless_equals_string()</h3>
248 <pre class="programlisting">#define             fail_unless_equals_string(a, b)</pre>
249 <p>
250 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal (as per strcmp) and aborts if
251 this is not the case, printing both expressions and the values they
252 evaluated to. This macro is for use in unit tests.
253 </p>
254 <div class="variablelist"><table border="0">
255 <col align="left" valign="top">
256 <tbody>
257 <tr>
258 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
259 <td>a string literal or expression</td>
260 </tr>
261 <tr>
262 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
263 <td>a string literal or expression</td>
264 </tr>
265 </tbody>
266 </table></div>
267 </div>
268 <hr>
269 <div class="refsect2">
270 <a name="fail-unless-equals-uint64"></a><h3>fail_unless_equals_uint64()</h3>
271 <pre class="programlisting">#define             fail_unless_equals_uint64(a, b)</pre>
272 <p>
273 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal and aborts if this is not the
274 case, printing both expressions and the values they evaluated to. This
275 macro is for use in unit tests.
276 </p>
277 <div class="variablelist"><table border="0">
278 <col align="left" valign="top">
279 <tbody>
280 <tr>
281 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
282 <td>a <span class="type">guint64</span> value or expression</td>
283 </tr>
284 <tr>
285 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
286 <td>a <span class="type">guint64</span> value or expression</td>
287 </tr>
288 </tbody>
289 </table></div>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="fail-unless-message-error"></a><h3>fail_unless_message_error()</h3>
294 <pre class="programlisting">#define             fail_unless_message_error(msg, domain, code)</pre>
295 </div>
296 <hr>
297 <div class="refsect2">
298 <a name="assert-equals-int"></a><h3>assert_equals_int()</h3>
299 <pre class="programlisting">#define assert_equals_int(a, b) fail_unless_equals_int(a, b)
300 </pre>
301 <p>
302 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal and aborts if this is not the
303 case, printing both expressions and the values they evaluated to. This
304 macro is for use in unit tests.
305 </p>
306 <div class="variablelist"><table border="0">
307 <col align="left" valign="top">
308 <tbody>
309 <tr>
310 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
311 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value or expression</td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
315 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value or expression</td>
316 </tr>
317 </tbody>
318 </table></div>
319 </div>
320 <hr>
321 <div class="refsect2">
322 <a name="assert-equals-float"></a><h3>assert_equals_float()</h3>
323 <pre class="programlisting">#define assert_equals_float(a, b) fail_unless_equals_float(a, b)
324 </pre>
325 <p>
326 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are (almost) equal and aborts if this
327 is not the case, printing both expressions and the values they evaluated
328 to. This macro is for use in unit tests.
329 </p>
330 <div class="variablelist"><table border="0">
331 <col align="left" valign="top">
332 <tbody>
333 <tr>
334 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
335 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value or expression</td>
336 </tr>
337 <tr>
338 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
339 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> value or expression</td>
340 </tr>
341 </tbody>
342 </table></div>
343 <p class="since">Since 0.10.14</p>
344 </div>
345 <hr>
346 <div class="refsect2">
347 <a name="assert-equals-string"></a><h3>assert_equals_string()</h3>
348 <pre class="programlisting">#define assert_equals_string(a, b) fail_unless_equals_string(a, b)
349 </pre>
350 <p>
351 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal (as per strcmp) and aborts if
352 this is not the case, printing both expressions and the values they
353 evaluated to. This macro is for use in unit tests.
354 </p>
355 <div class="variablelist"><table border="0">
356 <col align="left" valign="top">
357 <tbody>
358 <tr>
359 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
360 <td>a string literal or expression</td>
361 </tr>
362 <tr>
363 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
364 <td>a string literal or expression</td>
365 </tr>
366 </tbody>
367 </table></div>
368 </div>
369 <hr>
370 <div class="refsect2">
371 <a name="assert-equals-uint64"></a><h3>assert_equals_uint64()</h3>
372 <pre class="programlisting">#define assert_equals_uint64(a, b) fail_unless_equals_uint64(a, b)
373 </pre>
374 <p>
375 This macro checks that <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal and aborts if this is not the
376 case, printing both expressions and the values they evaluated to. This
377 macro is for use in unit tests.
378 </p>
379 <div class="variablelist"><table border="0">
380 <col align="left" valign="top">
381 <tbody>
382 <tr>
383 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
384 <td>a <span class="type">guint64</span> value or expression</td>
385 </tr>
386 <tr>
387 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
388 <td>a <span class="type">guint64</span> value or expression</td>
389 </tr>
390 </tbody>
391 </table></div>
392 </div>
393 <hr>
394 <div class="refsect2">
395 <a name="assert-message-error"></a><h3>assert_message_error()</h3>
396 <pre class="programlisting">#define assert_message_error(m, d, c) fail_unless_message_error(m, d, c)
397 </pre>
398 </div>
399 <hr>
400 <div class="refsect2">
401 <a name="gst-check-init"></a><h3>gst_check_init ()</h3>
402 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_init                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
403                                                          <em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);</pre>
404 </div>
405 <hr>
406 <div class="refsect2">
407 <a name="gst-check-message-error"></a><h3>gst_check_message_error ()</h3>
408 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_message_error             (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessage"><span class="type">GstMessage</span></a> *message</code></em>,
409                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMessage.html#GstMessageType"><span class="type">GstMessageType</span></a> type</code></em>,
410                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
411                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>);</pre>
412 </div>
413 <hr>
414 <div class="refsect2">
415 <a name="gst-check-setup-element"></a><h3>gst_check_setup_element ()</h3>
416 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="returnvalue">GstElement</span></a> *        gst_check_setup_element             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *factory</code></em>);</pre>
417 </div>
418 <hr>
419 <div class="refsect2">
420 <a name="gst-check-setup-sink-pad"></a><h3>gst_check_setup_sink_pad ()</h3>
421 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            gst_check_setup_sink_pad            (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
422                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
423                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
424 </div>
425 <hr>
426 <div class="refsect2">
427 <a name="gst-check-setup-src-pad"></a><h3>gst_check_setup_src_pad ()</h3>
428 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            gst_check_setup_src_pad             (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
429                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
430                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps</code></em>);</pre>
431 </div>
432 <hr>
433 <div class="refsect2">
434 <a name="gst-check-setup-sink-pad-by-name"></a><h3>gst_check_setup_sink_pad_by_name ()</h3>
435 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            gst_check_setup_sink_pad_by_name    (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
436                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
437                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
438 </div>
439 <hr>
440 <div class="refsect2">
441 <a name="gst-check-setup-src-pad-by-name"></a><h3>gst_check_setup_src_pad_by_name ()</h3>
442 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="returnvalue">GstPad</span></a> *            gst_check_setup_src_pad_by_name     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
443                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPadTemplate.html#GstStaticPadTemplate"><span class="type">GstStaticPadTemplate</span></a> *tmpl</code></em>,
444                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
445 </div>
446 <hr>
447 <div class="refsect2">
448 <a name="gst-check-teardown-pad-by-name"></a><h3>gst_check_teardown_pad_by_name ()</h3>
449 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_teardown_pad_by_name      (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>,
450                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
451 </div>
452 <hr>
453 <div class="refsect2">
454 <a name="gst-check-teardown-element"></a><h3>gst_check_teardown_element ()</h3>
455 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_teardown_element          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);</pre>
456 </div>
457 <hr>
458 <div class="refsect2">
459 <a name="gst-check-teardown-sink-pad"></a><h3>gst_check_teardown_sink_pad ()</h3>
460 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_teardown_sink_pad         (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);</pre>
461 </div>
462 <hr>
463 <div class="refsect2">
464 <a name="gst-check-teardown-src-pad"></a><h3>gst_check_teardown_src_pad ()</h3>
465 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_teardown_src_pad          (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> *element</code></em>);</pre>
466 </div>
467 <hr>
468 <div class="refsect2">
469 <a name="gst-check-drop-buffers"></a><h3>gst_check_drop_buffers ()</h3>
470 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_drop_buffers              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
471 <p>
472 Unref and remove all buffers that are in the global <em class="parameter"><code>buffers</code></em> GList,
473 emptying the list.
474 </p>
475 <p class="since">Since 0.10.18</p>
476 </div>
477 <hr>
478 <div class="refsect2">
479 <a name="gst-check-caps-equal"></a><h3>gst_check_caps_equal ()</h3>
480 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_caps_equal                (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps1</code></em>,
481                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> *caps2</code></em>);</pre>
482 <p>
483 Compare two caps with gst_caps_is_equal and fail unless they are
484 equal.
485 </p>
486 <div class="variablelist"><table border="0">
487 <col align="left" valign="top">
488 <tbody>
489 <tr>
490 <td><p><span class="term"><em class="parameter"><code>caps1</code></em> :</span></p></td>
491 <td>first caps to compare</td>
492 </tr>
493 <tr>
494 <td><p><span class="term"><em class="parameter"><code>caps2</code></em> :</span></p></td>
495 <td>second caps to compare</td>
496 </tr>
497 </tbody>
498 </table></div>
499 <p class="since">Since 0.10.18</p>
500 </div>
501 <hr>
502 <div class="refsect2">
503 <a name="gst-check-element-push-buffer-list"></a><h3>gst_check_element_push_buffer_list ()</h3>
504 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_element_push_buffer_list  (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *element_name</code></em>,
505                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *buffer_in</code></em>,
506                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *buffer_out</code></em>,
507                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html#GstFlowReturn"><span class="type">GstFlowReturn</span></a> last_flow_return</code></em>);</pre>
508 <p>
509 Create an <em class="parameter"><code>element</code></em> with the factory with the name and push the buffers in
510 <em class="parameter"><code>buffer_in</code></em> to this element. The element should create the buffers equal to
511 the buffers in <em class="parameter"><code>buffer_out</code></em>. We only check the caps, size and the data of the
512 buffers. This function unrefs the buffers in the two lists.
513 The last_flow_return parameter indicates the expected flow return value from
514 pushing the final buffer in the list.
515 This can be used to set up a test which pushes some buffers and then an
516 invalid buffer, when the final buffer is expected to fail, for example.
517 </p>
518 <div class="variablelist"><table border="0">
519 <col align="left" valign="top">
520 <tbody>
521 <tr>
522 <td><p><span class="term"><em class="parameter"><code>element_name</code></em> :</span></p></td>
523 <td>name of the element that needs to be created</td>
524 </tr>
525 <tr>
526 <td><p><span class="term"><em class="parameter"><code>buffer_in</code></em> :</span></p></td>
527 <td>a list of buffers that needs to be puched to the element</td>
528 </tr>
529 <tr>
530 <td><p><span class="term"><em class="parameter"><code>buffer_out</code></em> :</span></p></td>
531 <td>a list of buffers that we expect from the element</td>
532 </tr>
533 <tr>
534 <td><p><span class="term"><em class="parameter"><code>last_flow_return</code></em> :</span></p></td>
535 <td>the last buffer push needs to give this GstFlowReturn</td>
536 </tr>
537 </tbody>
538 </table></div>
539 <p class="since">Since 0.10.18</p>
540 </div>
541 <hr>
542 <div class="refsect2">
543 <a name="gst-check-element-push-buffer"></a><h3>gst_check_element_push_buffer ()</h3>
544 <pre class="programlisting"><span class="returnvalue">void</span>                gst_check_element_push_buffer       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *element_name</code></em>,
545                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer_in</code></em>,
546                                                          <em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buffer_out</code></em>);</pre>
547 <p>
548 Create an <em class="parameter"><code>element</code></em> with the factory with the name and push the
549 <em class="parameter"><code>buffer_in</code></em> to this element. The element should create one buffer
550 and this will be compared with <em class="parameter"><code>buffer_out</code></em>. We only check the caps
551 and the data of the buffers. This function unrefs the buffers.
552 </p>
553 <div class="variablelist"><table border="0">
554 <col align="left" valign="top">
555 <tbody>
556 <tr>
557 <td><p><span class="term"><em class="parameter"><code>element_name</code></em> :</span></p></td>
558 <td>name of the element that needs to be created</td>
559 </tr>
560 <tr>
561 <td><p><span class="term"><em class="parameter"><code>buffer_in</code></em> :</span></p></td>
562 <td>push this buffer to the element</td>
563 </tr>
564 <tr>
565 <td><p><span class="term"><em class="parameter"><code>buffer_out</code></em> :</span></p></td>
566 <td>compare the result with this buffer</td>
567 </tr>
568 </tbody>
569 </table></div>
570 <p class="since">Since 0.10.18</p>
571 </div>
572 <hr>
573 <div class="refsect2">
574 <a name="gst-check-run-suite"></a><h3>gst_check_run_suite ()</h3>
575 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gst_check_run_suite                 (<em class="parameter"><code><span class="type">Suite</span> *suite</code></em>,
576                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
577                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *fname</code></em>);</pre>
578 </div>
579 </div>
580 </div>
581 <div class="footer">
582 <hr>
583           Generated by GTK-Doc V1.18</div>
584 </body>
585 </html>