DEBIAN: Debianization
[glsdk/gstreamer0-10.git] / libs / gst / check / gstcheck.h
1 /* GStreamer
2  *
3  * Common code for GStreamer unittests
4  *
5  * Copyright (C) <2004> Thomas Vander Stichele <thomas at apestaart dot org>
6  * Copyright (C) <2008> Thijs Vermeir <thijsvermeir@gmail.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
24 #ifndef __GST_CHECK_H__
25 #define __GST_CHECK_H__
27 #include <signal.h>
28 #include <string.h>
29 #include <stdlib.h>
30 #include <math.h>
32 #include <gst/check/internal-check.h>
34 #include <gst/gst.h>
36 G_BEGIN_DECLS
38 GST_DEBUG_CATEGORY_EXTERN (check_debug);
39 #define GST_CAT_DEFAULT check_debug
41 /* logging function for tests
42  * a test uses g_message() to log a debug line
43  * a gst unit test can be run with GST_TEST_DEBUG env var set to see the
44  * messages
45  */
46 extern gboolean _gst_check_threads_running;
47 extern gboolean _gst_check_raised_critical;
48 extern gboolean _gst_check_raised_warning;
49 extern gboolean _gst_check_expecting_log;
51 /* global variables used in test methods */
52 extern GList * buffers;
54 extern GMutex *check_mutex;
55 extern GCond *check_cond;
57 typedef struct
58 {
59   const char *name;
60   int size;
61   int abi_size;
62 }
63 GstCheckABIStruct;
65 void gst_check_init (int *argc, char **argv[]);
67 GstFlowReturn gst_check_chain_func (GstPad * pad, GstBuffer * buffer);
69 void gst_check_message_error (GstMessage * message, GstMessageType type,
70     GQuark domain, gint code);
72 GstElement *gst_check_setup_element (const gchar * factory);
73 void gst_check_teardown_element (GstElement * element);
74 GstPad *gst_check_setup_src_pad (GstElement * element,
75     GstStaticPadTemplate * tmpl, GstCaps * caps);
76 GstPad * gst_check_setup_src_pad_by_name (GstElement * element,
77           GstStaticPadTemplate * tmpl, const gchar *name);
78 GstPad * gst_check_setup_sink_pad_by_name (GstElement * element, 
79           GstStaticPadTemplate * tmpl, const gchar *name);
80 void gst_check_teardown_pad_by_name (GstElement * element, const gchar *name);
81 void gst_check_teardown_src_pad (GstElement * element);
82 void gst_check_drop_buffers (void);
83 void gst_check_caps_equal (GstCaps * caps1, GstCaps * caps2);
84 void gst_check_element_push_buffer_list (const gchar * element_name,
85     GList * buffer_in, GList * buffer_out, GstFlowReturn last_flow_return);
86 void gst_check_element_push_buffer (const gchar * element_name,
87     GstBuffer * buffer_in, GstBuffer * buffer_out);
88 GstPad *gst_check_setup_sink_pad (GstElement * element,
89     GstStaticPadTemplate * tmpl, GstCaps * caps);
90 void gst_check_teardown_sink_pad (GstElement * element);
91 void gst_check_abi_list (GstCheckABIStruct list[], gboolean have_abi_sizes);
92 gint gst_check_run_suite (Suite * suite, const gchar * name,
93     const gchar * fname);
95 #define fail_unless_message_error(msg, domain, code)            \
96 gst_check_message_error (msg, GST_MESSAGE_ERROR,                \
97   GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code)
98 #define assert_message_error(m, d, c) fail_unless_message_error(m, d, c)
100 /**
101  * GST_START_TEST:
102  * @__testname: test function name
103  *
104  * wrapper for checks START_TEST
105  */
106 /**
107  * GST_END_TEST:
108  *
109  * wrapper for checks END_TEST
110  */
111 #define GST_START_TEST(__testname) \
112 static void __testname (int __i__)\
113 {\
114   GST_DEBUG ("test start"); \
115   tcase_fn_start (""# __testname, __FILE__, __LINE__);
117 #define GST_END_TEST GST_LOG ("cleaning up tasks"); \
118                      gst_task_cleanup_all (); \
119                      END_TEST
121 /* additional fail macros */
122 /**
123  * fail_unless_equals_int:
124  * @a: a #gint value or expression
125  * @b: a #gint value or expression
126  *
127  * This macro checks that @a and @b are equal and aborts if this is not the
128  * case, printing both expressions and the values they evaluated to. This
129  * macro is for use in unit tests.
130  */
131 #define fail_unless_equals_int(a, b)                                    \
132 G_STMT_START {                                                          \
133   int first = a;                                                        \
134   int second = b;                                                       \
135   fail_unless(first == second,                                          \
136     "'" #a "' (%d) is not equal to '" #b"' (%d)", first, second);       \
137 } G_STMT_END;
138 /**
139  * assert_equals_int:
140  * @a: a #gint value or expression
141  * @b: a #gint value or expression
142  *
143  * This macro checks that @a and @b are equal and aborts if this is not the
144  * case, printing both expressions and the values they evaluated to. This
145  * macro is for use in unit tests.
146  */
147 #define assert_equals_int(a, b) fail_unless_equals_int(a, b)
149 /**
150  * fail_unless_equals_int64:
151  * @a: a #gint64 value or expression
152  * @b: a #gint64 value or expression
153  *
154  * This macro checks that @a and @b are equal and aborts if this is not the
155  * case, printing both expressions and the values they evaluated to. This
156  * macro is for use in unit tests.
157  */
158 #define fail_unless_equals_int64(a, b)                                  \
159 G_STMT_START {                                                          \
160   gint64 first = a;                                                     \
161   gint64 second = b;                                                    \
162   fail_unless(first == second,                                          \
163     "'" #a "' (%" G_GINT64_FORMAT") is not equal to '" #b"' (%"         \
164     G_GINT64_FORMAT")", first, second);                                 \
165 } G_STMT_END;
166 /**
167  * assert_equals_int64:
168  * @a: a #gint64 value or expression
169  * @b: a #gint64 value or expression
170  *
171  * This macro checks that @a and @b are equal and aborts if this is not the
172  * case, printing both expressions and the values they evaluated to. This
173  * macro is for use in unit tests.
174  */
175 #define assert_equals_int64(a, b) fail_unless_equals_int64(a, b)
177 /**
178  * fail_unless_equals_uint64:
179  * @a: a #guint64 value or expression
180  * @b: a #guint64 value or expression
181  *
182  * This macro checks that @a and @b are equal and aborts if this is not the
183  * case, printing both expressions and the values they evaluated to. This
184  * macro is for use in unit tests.
185  */
186 #define fail_unless_equals_uint64(a, b)                                 \
187 G_STMT_START {                                                          \
188   guint64 first = a;                                                    \
189   guint64 second = b;                                                   \
190   fail_unless(first == second,                                          \
191     "'" #a "' (%" G_GUINT64_FORMAT ") is not equal to '" #b"' (%"       \
192     G_GUINT64_FORMAT ")", first, second);                               \
193 } G_STMT_END;
194 /**
195  * assert_equals_uint64:
196  * @a: a #guint64 value or expression
197  * @b: a #guint64 value or expression
198  *
199  * This macro checks that @a and @b are equal and aborts if this is not the
200  * case, printing both expressions and the values they evaluated to. This
201  * macro is for use in unit tests.
202  */
203 #define assert_equals_uint64(a, b) fail_unless_equals_uint64(a, b)
205 /**
206  * fail_unless_equals_string:
207  * @a: a string literal or expression
208  * @b: a string literal or expression
209  *
210  * This macro checks that @a and @b are equal (as per strcmp) and aborts if
211  * this is not the case, printing both expressions and the values they
212  * evaluated to. This macro is for use in unit tests.
213  */
214 #define fail_unless_equals_string(a, b)                             \
215 G_STMT_START {                                                      \
216   const gchar * first = a;                                          \
217   const gchar * second = b;                                         \
218   fail_unless(g_strcmp0 (first, second) == 0,                          \
219     "'" #a "' (%s) is not equal to '" #b"' (%s)", first, second);   \
220 } G_STMT_END;
221 /**
222  * assert_equals_string:
223  * @a: a string literal or expression
224  * @b: a string literal or expression
225  *
226  * This macro checks that @a and @b are equal (as per strcmp) and aborts if
227  * this is not the case, printing both expressions and the values they
228  * evaluated to. This macro is for use in unit tests.
229  */
230 #define assert_equals_string(a, b) fail_unless_equals_string(a, b)
232 /**
233  * fail_unless_equals_float:
234  * @a: a #gdouble or #gfloat value or expression
235  * @b: a #gdouble or #gfloat value or expression
236  *
237  * This macro checks that @a and @b are (almost) equal and aborts if this
238  * is not the case, printing both expressions and the values they evaluated
239  * to. This macro is for use in unit tests.
240  *
241  * Since: 0.10.14
242  */
243 #define fail_unless_equals_float(a, b)                            \
244 G_STMT_START {                                                    \
245   double first = a;                                               \
246   double second = b;                                              \
247   /* This will only work for 'normal' values and values around 0, \
248    * which should be good enough for our purposes here */         \
249   fail_unless(fabs (first - second) < 0.0000001,                  \
250     "'" #a "' (%g) is not equal to '" #b "' (%g)", first, second);\
251 } G_STMT_END;
253 /**
254  * assert_equals_float:
255  * @a: a #gdouble or #gfloat value or expression
256  * @b: a #gdouble or #gfloat value or expression
257  *
258  * This macro checks that @a and @b are (almost) equal and aborts if this
259  * is not the case, printing both expressions and the values they evaluated
260  * to. This macro is for use in unit tests.
261  *
262  * Since: 0.10.14
263  */
264 #define assert_equals_float(a, b) fail_unless_equals_float(a, b)
267 /***
268  * thread test macros and variables
269  */
270 extern GList *thread_list;
271 extern GMutex *mutex;
272 extern GCond *start_cond;       /* used to notify main thread of thread startups */
273 extern GCond *sync_cond;        /* used to synchronize all threads and main thread */
275 #define MAIN_START_THREADS(count, function, data)               \
276 MAIN_INIT();                                                    \
277 MAIN_START_THREAD_FUNCTIONS(count, function, data);             \
278 MAIN_SYNCHRONIZE();
280 #if GLIB_CHECK_VERSION (2, 31, 0)
281 #define g_thread_create gst_g_thread_create
282 static inline GThread *
283 gst_g_thread_create (GThreadFunc func, gpointer data, gboolean joinable,
284     GError **error)
286   GThread *thread = g_thread_try_new ("gst-check", func, data, error);
287   if (!joinable)
288     g_thread_unref (thread);
289   return thread;
291 #define g_mutex_new gst_g_mutex_new
292 static inline GMutex *
293 gst_g_mutex_new (void)
295   GMutex *mutex = g_slice_new (GMutex);
296   g_mutex_init (mutex);
297   return mutex;
299 #define g_mutex_free gst_g_mutex_free
300 static inline void
301 gst_g_mutex_free (GMutex *mutex)
303   g_mutex_clear (mutex);
304   g_slice_free (GMutex, mutex);
306 #define g_static_rec_mutex_init gst_g_static_rec_mutex_init
307 static inline void
308 gst_g_static_rec_mutex_init (GStaticRecMutex *mutex)
310   static const GStaticRecMutex init_mutex = G_STATIC_REC_MUTEX_INIT;
312   *mutex = init_mutex;
314 #define g_cond_new gst_g_cond_new
315 static inline GCond *
316 gst_g_cond_new (void)
318   GCond *cond = g_slice_new (GCond);
319   g_cond_init (cond);
320   return cond;
322 #define g_cond_free gst_g_cond_free
323 static inline void
324 gst_g_cond_free (GCond *cond)
326   g_cond_clear (cond);
327   g_slice_free (GCond, cond);
329 #define g_cond_timed_wait gst_g_cond_timed_wait
330 static inline gboolean
331 gst_g_cond_timed_wait (GCond *cond, GMutex *mutex, GTimeVal *abs_time)
333   gint64 end_time;
335   if (abs_time == NULL) {
336     g_cond_wait (cond, mutex);
337     return TRUE;
338   }
340   end_time = abs_time->tv_sec;
341   end_time *= 1000000;
342   end_time += abs_time->tv_usec;
344   /* would be nice if we had clock_rtoffset, but that didn't seem to
345    * make it into the kernel yet...
346    */
347   /* if CLOCK_MONOTONIC is not defined then g_get_montonic_time() and
348    * g_get_real_time() are returning the same clock and we'd add ~0
349    */
350   end_time += g_get_monotonic_time () - g_get_real_time ();
351   return g_cond_wait_until (cond, mutex, end_time);
353 #endif
355 #define MAIN_INIT()                     \
356 G_STMT_START {                          \
357   _gst_check_threads_running = TRUE;    \
358                                         \
359   if (mutex == NULL) {                  \
360     mutex = g_mutex_new ();             \
361     start_cond = g_cond_new ();         \
362     sync_cond = g_cond_new ();          \
363   }                                     \
364 } G_STMT_END;
366 #define MAIN_START_THREAD_FUNCTIONS(count, function, data)      \
367 G_STMT_START {                                                  \
368   int i;                                                        \
369   for (i = 0; i < count; ++i) {                                 \
370     MAIN_START_THREAD_FUNCTION (i, function, data);             \
371   }                                                             \
372 } G_STMT_END;
374 #define MAIN_START_THREAD_FUNCTION(i, function, data)           \
375 G_STMT_START {                                                  \
376     GThread *thread = NULL;                                     \
377     GST_DEBUG ("MAIN: creating thread %d", i);                  \
378     g_mutex_lock (mutex);                                       \
379     thread = g_thread_create ((GThreadFunc) function, data,     \
380         TRUE, NULL);                                            \
381     /* wait for thread to signal us that it's ready */          \
382     GST_DEBUG ("MAIN: waiting for thread %d", i);               \
383     g_cond_wait (start_cond, mutex);                            \
384     g_mutex_unlock (mutex);                                     \
385                                                                 \
386     thread_list = g_list_append (thread_list, thread);          \
387 } G_STMT_END;
390 #define MAIN_SYNCHRONIZE()              \
391 G_STMT_START {                          \
392   GST_DEBUG ("MAIN: synchronizing");    \
393   g_cond_broadcast (sync_cond);         \
394   GST_DEBUG ("MAIN: synchronized");     \
395 } G_STMT_END;
397 #define MAIN_STOP_THREADS()                                     \
398 G_STMT_START {                                                  \
399   _gst_check_threads_running = FALSE;                           \
400                                                                 \
401   /* join all threads */                                        \
402   GST_DEBUG ("MAIN: joining");                                  \
403   g_list_foreach (thread_list, (GFunc) g_thread_join, NULL);    \
404   g_list_free (thread_list);                                    \
405   thread_list = NULL;                                           \
406   GST_DEBUG ("MAIN: joined");                                   \
407 } G_STMT_END;
409 #define THREAD_START()                                          \
410 THREAD_STARTED();                                               \
411 THREAD_SYNCHRONIZE();
413 #define THREAD_STARTED()                                        \
414 G_STMT_START {                                                  \
415   /* signal main thread that we started */                      \
416   GST_DEBUG ("THREAD %p: started", g_thread_self ());           \
417   g_mutex_lock (mutex);                                         \
418   g_cond_signal (start_cond);                                   \
419 } G_STMT_END;
421 #define THREAD_SYNCHRONIZE()                                    \
422 G_STMT_START {                                                  \
423   /* synchronize everyone */                                    \
424   GST_DEBUG ("THREAD %p: syncing", g_thread_self ());           \
425   g_cond_wait (sync_cond, mutex);                               \
426   GST_DEBUG ("THREAD %p: synced", g_thread_self ());            \
427   g_mutex_unlock (mutex);                                       \
428 } G_STMT_END;
430 #define THREAD_SWITCH()                                         \
431 G_STMT_START {                                                  \
432   /* a minimal sleep is a context switch */                     \
433   g_usleep (1);                                                 \
434 } G_STMT_END;
436 #define THREAD_TEST_RUNNING()   (_gst_check_threads_running == TRUE)
438 /* additional assertions */
439 #define ASSERT_CRITICAL(code)                                   \
440 G_STMT_START {                                                  \
441   _gst_check_expecting_log = TRUE;                              \
442   _gst_check_raised_critical = FALSE;                           \
443   code;                                                         \
444   _fail_unless (_gst_check_raised_critical, __FILE__, __LINE__, \
445                 "Expected g_critical, got nothing", NULL);      \
446   _gst_check_expecting_log = FALSE;                             \
447 } G_STMT_END
449 #define ASSERT_WARNING(code)                                    \
450 G_STMT_START {                                                  \
451   _gst_check_expecting_log = TRUE;                              \
452   _gst_check_raised_warning = FALSE;                            \
453   code;                                                         \
454   _fail_unless (_gst_check_raised_warning, __FILE__, __LINE__,  \
455                 "Expected g_warning, got nothing", NULL);       \
456   _gst_check_expecting_log = FALSE;                             \
457 } G_STMT_END
460 #define ASSERT_OBJECT_REFCOUNT(object, name, value)             \
461 G_STMT_START {                                                  \
462   int rc;                                                       \
463   rc = GST_OBJECT_REFCOUNT_VALUE (object);                      \
464   fail_unless (rc == value,                                     \
465       "%s (%p) refcount is %d instead of %d",                   \
466       name, object, rc, value);                                 \
467 } G_STMT_END
469 #define ASSERT_OBJECT_REFCOUNT_BETWEEN(object, name, lower, upper)      \
470 G_STMT_START {                                                          \
471   int rc = GST_OBJECT_REFCOUNT_VALUE (object);                          \
472   int lo = lower;                                                       \
473   int hi = upper;                                                       \
474                                                                         \
475   fail_unless (rc >= lo,                                                \
476       "%s (%p) refcount %d is smaller than %d",                         \
477       name, object, rc, lo);                                            \
478   fail_unless (rc <= hi,                                                \
479       "%s (%p) refcount %d is bigger than %d",                          \
480       name, object, rc, hi);                                            \
481 } G_STMT_END
484 #define ASSERT_CAPS_REFCOUNT(caps, name, value)                 \
485         ASSERT_MINI_OBJECT_REFCOUNT(caps, name, value)
487 #define ASSERT_BUFFER_REFCOUNT(buffer, name, value)             \
488         ASSERT_MINI_OBJECT_REFCOUNT(buffer, name, value)
490 #define ASSERT_MINI_OBJECT_REFCOUNT(caps, name, value)          \
491 G_STMT_START {                                                  \
492   int rc;                                                       \
493   rc = GST_MINI_OBJECT_REFCOUNT_VALUE (caps);                   \
494   fail_unless (rc == value,                                     \
495                name " refcount is %d instead of %d", rc, value);\
496 } G_STMT_END
498 #define ASSERT_SET_STATE(element, state, ret)                   \
499 fail_unless (gst_element_set_state (element,                    \
500   state) == ret,                                                \
501   "could not change state to " #state);
503 #define GST_CHECK_MAIN(name)                                    \
504 int main (int argc, char **argv)                                \
505 {                                                               \
506   Suite *s;                                                     \
507   gst_check_init (&argc, &argv);                                \
508   s = name ## _suite ();                                        \
509   return gst_check_run_suite (s, # name, __FILE__);             \
512 /* Hack to allow run-time selection of unit tests to run via the
513  * GST_CHECKS environment variable (test function names, comma-separated) */
515 gboolean _gst_check_run_test_func (const gchar * func_name);
517 static inline void
518 __gst_tcase_add_test (TCase * tc, TFun tf, const char * fname, int signal,
519     int allowed_exit_value, int start, int end)
521   if (_gst_check_run_test_func (fname)) {
522     _tcase_add_test (tc, tf, fname, signal, allowed_exit_value, start, end);
523   }
526 #define _tcase_add_test __gst_tcase_add_test
528 G_END_DECLS
530 #endif /* __GST_CHECK_H__ */