3 * unit test for GstMeta
5 * Copyright (C) <2009> Wim Taymans <wim.taymans@gmail.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.
27 #include <gst/check/gstcheck.h>
29 /* test metadata for PTS/DTS and duration */
36 GstClockTime duration;
37 GstClockTime clock_rate;
40 static GType gst_meta_test_api_get_type (void);
41 #define GST_META_TEST_API_TYPE (gst_meta_test_api_get_type())
43 static const GstMetaInfo *gst_meta_test_get_info (void);
44 #define GST_META_TEST_INFO (gst_meta_test_get_info())
46 #define GST_META_TEST_GET(buf) ((GstMetaTest *)gst_buffer_get_meta(buf,GST_META_TEST_API_TYPE))
47 #define GST_META_TEST_ADD(buf) ((GstMetaTest *)gst_buffer_add_meta(buf,GST_META_TEST_INFO,NULL))
54 static GType gst_meta_foo_api_get_type (void);
55 #define GST_META_FOO_API_TYPE (gst_meta_foo_api_get_type())
57 static const GstMetaInfo *gst_meta_foo_get_info (void);
58 #define GST_META_FOO_INFO (gst_meta_foo_get_info())
60 #define GST_META_FOO_GET(buf) ((GstMetaFoo *)gst_buffer_get_meta(buf,GST_META_FOO_API_TYPE))
61 #define GST_META_FOO_ADD(buf) ((GstMetaFoo *)gst_buffer_add_meta(buf,GST_META_FOO_INFO,NULL))
64 /* unused currently. This is a user function to fill the metadata with default
65 * values. We don't call this from the init function because the user is mostly
66 * likely going to override the values immediately after */
68 gst_meta_test_init (GstMetaTest * meta)
70 meta->pts = GST_CLOCK_TIME_NONE;
71 meta->dts = GST_CLOCK_TIME_NONE;
72 meta->duration = GST_CLOCK_TIME_NONE;
73 meta->clock_rate = GST_SECOND;
78 test_init_func (GstMeta * meta, gpointer params, GstBuffer * buffer)
80 GST_DEBUG ("init called on buffer %p, meta %p", buffer, meta);
81 /* nothing to init really, the init function is mostly for allocating
82 * additional memory or doing special setup as part of adding the metadata to
88 test_free_func (GstMeta * meta, GstBuffer * buffer)
90 GST_DEBUG ("free called on buffer %p, meta %p", buffer, meta);
91 /* nothing to free really */
95 test_transform_func (GstBuffer * transbuf, GstMeta * meta,
96 GstBuffer * buffer, GQuark type, gpointer data)
98 GstMetaTest *test, *tmeta = (GstMetaTest *) meta;
100 GST_DEBUG ("transform %s called from buffer %p to %p, meta %p",
101 g_quark_to_string (type), buffer, transbuf, meta);
103 if (GST_META_TRANSFORM_IS_COPY (type)) {
104 GstMetaTransformCopy *copy_data = data;
106 test = GST_META_TEST_ADD (transbuf);
108 if (copy_data->offset == 0) {
109 /* same offset, copy timestamps */
110 test->pts = tmeta->pts;
111 test->dts = tmeta->dts;
112 if (!copy_data->region) {
113 fail_unless (gst_buffer_get_size (buffer) == copy_data->size);
114 /* same size, copy duration */
115 test->duration = tmeta->duration;
117 fail_unless (gst_buffer_get_size (buffer) > copy_data->size);
119 test->duration = GST_CLOCK_TIME_NONE;
122 fail_unless (copy_data->region == TRUE);
127 test->clock_rate = tmeta->clock_rate;
129 /* return FALSE, if transform type is not supported */
136 gst_meta_test_api_get_type (void)
138 static volatile GType type;
139 static const gchar *tags[] = { "timing", NULL };
141 if (g_once_init_enter (&type)) {
142 GType _type = gst_meta_api_type_register ("GstMetaTestAPI", tags);
143 g_once_init_leave (&type, _type);
149 foo_init_func (GstMeta * meta, gpointer params, GstBuffer * buffer)
151 GST_DEBUG ("init called on buffer %p, foo meta %p", buffer, meta);
156 foo_free_func (GstMeta * meta, GstBuffer * buffer)
158 GST_DEBUG ("free called on buffer %p, foo meta %p", buffer, meta);
162 static const GstMetaInfo *
163 gst_meta_test_get_info (void)
165 static const GstMetaInfo *meta_test_info = NULL;
167 if (g_once_init_enter ((GstMetaInfo **) & meta_test_info)) {
168 const GstMetaInfo *mi = gst_meta_register (GST_META_TEST_API_TYPE,
170 sizeof (GstMetaTest),
171 test_init_func, test_free_func, test_transform_func);
172 g_once_init_leave ((GstMetaInfo **) & meta_test_info, (GstMetaInfo *) mi);
174 return meta_test_info;
178 foo_transform_func (GstBuffer * transbuf, GstMeta * meta,
179 GstBuffer * buffer, GQuark type, gpointer data)
181 GST_DEBUG ("transform %s called from buffer %p to %p, meta %p",
182 g_quark_to_string (type), buffer, transbuf, meta);
184 if (GST_META_TRANSFORM_IS_COPY (type)) {
185 GST_META_FOO_ADD (transbuf);
187 /* return FALSE, if transform type is not supported */
194 gst_meta_foo_api_get_type (void)
196 static volatile GType type;
197 static const gchar *tags[] = { NULL };
199 if (g_once_init_enter (&type)) {
200 GType _type = gst_meta_api_type_register ("GstMetaFooAPI", tags);
201 g_once_init_leave (&type, _type);
206 static const GstMetaInfo *
207 gst_meta_foo_get_info (void)
209 static const GstMetaInfo *meta_foo_info = NULL;
211 if (g_once_init_enter ((GstMetaInfo **) & meta_foo_info)) {
212 const GstMetaInfo *mi = gst_meta_register (GST_META_FOO_API_TYPE,
215 foo_init_func, foo_free_func, foo_transform_func);
216 g_once_init_leave ((GstMetaInfo **) & meta_foo_info, (GstMetaInfo *) mi);
218 return meta_foo_info;
221 GST_START_TEST (test_meta_test)
223 GstBuffer *buffer, *copy, *subbuf;
227 buffer = gst_buffer_new_and_alloc (4);
228 fail_if (buffer == NULL);
230 fail_unless (gst_buffer_map (buffer, &info, GST_MAP_WRITE));
231 fail_if (info.data == NULL);
232 memset (info.data, 0, 4);
233 gst_buffer_unmap (buffer, &info);
235 /* add some metadata */
236 meta = GST_META_TEST_ADD (buffer);
237 fail_if (meta == NULL);
238 /* fill some values */
241 meta->duration = 1000;
242 meta->clock_rate = 1000;
244 /* copy of the buffer */
245 copy = gst_buffer_copy (buffer);
246 /* get metadata of the buffer */
247 meta = GST_META_TEST_GET (copy);
248 fail_if (meta == NULL);
249 fail_if (meta->pts != 1000);
250 fail_if (meta->dts != 2000);
251 fail_if (meta->duration != 1000);
252 fail_if (meta->clock_rate != 1000);
253 gst_buffer_unref (copy);
256 subbuf = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, 0, 1);
257 /* get metadata of the buffer */
258 meta = GST_META_TEST_GET (subbuf);
259 fail_if (meta == NULL);
260 fail_if (meta->pts != 1000);
261 fail_if (meta->dts != 2000);
262 fail_if (meta->duration != -1);
263 fail_if (meta->clock_rate != 1000);
264 gst_buffer_unref (subbuf);
266 /* make another subbuffer */
267 subbuf = gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, 1, 3);
268 /* get metadata of the buffer */
269 meta = GST_META_TEST_GET (subbuf);
270 fail_if (meta == NULL);
271 fail_if (meta->pts != -1);
272 fail_if (meta->dts != -1);
273 fail_if (meta->duration != -1);
274 fail_if (meta->clock_rate != 1000);
275 gst_buffer_unref (subbuf);
278 gst_buffer_unref (buffer);
284 foreach_meta (GstBuffer * buffer, GstMeta ** meta, gpointer user_data)
291 GST_START_TEST (test_meta_locked)
296 buffer = gst_buffer_new_and_alloc (4);
297 fail_if (buffer == NULL);
299 /* add some metadata */
300 meta = GST_META_TEST_ADD (buffer);
301 fail_if (meta == NULL);
302 GST_META_FLAG_SET (meta, GST_META_FLAG_LOCKED);
304 ASSERT_CRITICAL (gst_buffer_remove_meta (buffer, (GstMeta *) meta));
305 ASSERT_CRITICAL (gst_buffer_foreach_meta (buffer, foreach_meta, NULL));
307 GST_META_FLAG_UNSET (meta, GST_META_FLAG_LOCKED);
309 gst_buffer_remove_meta (buffer, (GstMeta *) meta);
312 gst_buffer_unref (buffer);
318 foreach_meta_remove_one (GstBuffer * buffer, GstMeta ** meta,
321 if (*meta == to_remove) {
329 count_buffer_meta (GstBuffer * buffer)
332 gpointer state = NULL;
334 while (gst_buffer_iterate_meta (buffer, &state))
340 GST_START_TEST (test_meta_foreach_remove_one_of_one)
344 gpointer state = NULL;
346 buffer = gst_buffer_new_and_alloc (4);
347 fail_if (buffer == NULL);
349 /* add some metadata */
350 meta1 = GST_META_TEST_ADD (buffer);
351 fail_if (meta1 == NULL);
353 fail_unless_equals_int (count_buffer_meta (buffer), 1);
355 gst_buffer_foreach_meta (buffer, foreach_meta_remove_one, meta1);
357 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
360 gst_buffer_unref (buffer);
365 GST_START_TEST (test_meta_foreach_remove_head_of_three)
368 GstMetaTest *meta1, *meta2, *meta3;
369 gpointer state = NULL;
371 buffer = gst_buffer_new_and_alloc (4);
372 fail_if (buffer == NULL);
374 /* add some metadata */
375 meta1 = GST_META_TEST_ADD (buffer);
376 fail_if (meta1 == NULL);
377 meta2 = GST_META_TEST_ADD (buffer);
378 fail_if (meta2 == NULL);
379 meta3 = GST_META_TEST_ADD (buffer);
380 fail_if (meta3 == NULL);
382 fail_unless_equals_int (count_buffer_meta (buffer), 3);
384 gst_buffer_foreach_meta (buffer, foreach_meta_remove_one, meta3);
386 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta2);
387 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta1);
388 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
391 gst_buffer_unref (buffer);
396 GST_START_TEST (test_meta_foreach_remove_middle_of_three)
399 GstMetaTest *meta1, *meta2, *meta3;
400 gpointer state = NULL;
402 buffer = gst_buffer_new_and_alloc (4);
403 fail_if (buffer == NULL);
405 /* add some metadata */
406 meta1 = GST_META_TEST_ADD (buffer);
407 fail_if (meta1 == NULL);
408 meta2 = GST_META_TEST_ADD (buffer);
409 fail_if (meta2 == NULL);
410 meta3 = GST_META_TEST_ADD (buffer);
411 fail_if (meta3 == NULL);
413 fail_unless_equals_int (count_buffer_meta (buffer), 3);
415 gst_buffer_foreach_meta (buffer, foreach_meta_remove_one, meta2);
417 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta3);
418 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta1);
419 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
422 gst_buffer_unref (buffer);
427 GST_START_TEST (test_meta_foreach_remove_tail_of_three)
430 GstMetaTest *meta1, *meta2, *meta3;
431 gpointer state = NULL;
433 buffer = gst_buffer_new_and_alloc (4);
434 fail_if (buffer == NULL);
436 /* add some metadata */
437 meta1 = GST_META_TEST_ADD (buffer);
438 fail_if (meta1 == NULL);
439 meta2 = GST_META_TEST_ADD (buffer);
440 fail_if (meta2 == NULL);
441 meta3 = GST_META_TEST_ADD (buffer);
442 fail_if (meta3 == NULL);
444 fail_unless_equals_int (count_buffer_meta (buffer), 3);
446 gst_buffer_foreach_meta (buffer, foreach_meta_remove_one, meta1);
448 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta3);
449 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta2);
450 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
453 gst_buffer_unref (buffer);
459 foreach_meta_remove_unpooled (GstBuffer * buffer, GstMeta ** meta,
462 if (!GST_META_FLAG_IS_SET (*meta, GST_META_FLAG_POOLED)) {
469 GST_START_TEST (test_meta_foreach_remove_head_and_tail_of_three)
472 GstMetaTest *meta1, *meta2, *meta3;
473 gpointer state = NULL;
475 buffer = gst_buffer_new_and_alloc (4);
476 fail_if (buffer == NULL);
478 /* add some metadata */
479 meta1 = GST_META_TEST_ADD (buffer);
480 fail_if (meta1 == NULL);
481 meta2 = GST_META_TEST_ADD (buffer);
482 fail_if (meta2 == NULL);
483 GST_META_FLAG_SET (meta2, GST_META_FLAG_POOLED);
484 meta3 = GST_META_TEST_ADD (buffer);
485 fail_if (meta3 == NULL);
487 fail_unless_equals_int (count_buffer_meta (buffer), 3);
489 gst_buffer_foreach_meta (buffer, foreach_meta_remove_unpooled, NULL);
491 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta2);
492 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
495 gst_buffer_unref (buffer);
501 GST_START_TEST (test_meta_foreach_remove_several)
504 GstMetaTest *meta1, *meta2, *meta3, *meta4, *meta5;
505 gpointer state = NULL;
507 buffer = gst_buffer_new_and_alloc (4);
508 fail_if (buffer == NULL);
510 /* add some metadata */
511 meta1 = GST_META_TEST_ADD (buffer);
512 fail_if (meta1 == NULL);
513 meta2 = GST_META_TEST_ADD (buffer);
514 fail_if (meta2 == NULL);
515 GST_META_FLAG_SET (meta2, GST_META_FLAG_POOLED);
516 meta3 = GST_META_TEST_ADD (buffer);
517 fail_if (meta3 == NULL);
518 meta4 = GST_META_TEST_ADD (buffer);
519 fail_if (meta4 == NULL);
520 meta5 = GST_META_TEST_ADD (buffer);
521 fail_if (meta5 == NULL);
522 GST_META_FLAG_SET (meta5, GST_META_FLAG_POOLED);
524 fail_unless_equals_int (count_buffer_meta (buffer), 5);
526 gst_buffer_foreach_meta (buffer, foreach_meta_remove_unpooled, NULL);
528 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta5);
529 fail_unless (gst_buffer_iterate_meta (buffer, &state) == (GstMeta *) meta2);
530 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
533 gst_buffer_unref (buffer);
538 GST_START_TEST (test_meta_iterate)
541 GstMeta *m1, *m2, *m3, *m_found;
545 /* buffer with single meta */
546 buffer = gst_buffer_new_and_alloc (4);
547 m1 = (GstMeta *) GST_META_TEST_ADD (buffer);
548 fail_unless (m1 != NULL);
551 fail_unless (gst_buffer_iterate_meta (buffer, &state) != NULL);
552 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
555 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
556 GST_META_TEST_API_TYPE) != NULL);
557 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
558 GST_META_TEST_API_TYPE) == NULL);
561 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
562 GST_META_FOO_API_TYPE) == NULL);
565 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
566 GST_META_TEST_API_TYPE) != NULL);
567 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
568 GST_META_TEST_API_TYPE) == NULL);
570 /* buffer with multiple metas */
571 m2 = (GstMeta *) GST_META_FOO_ADD (buffer);
572 fail_unless (m2 != NULL);
573 m3 = (GstMeta *) GST_META_TEST_ADD (buffer);
574 fail_unless (m3 != NULL);
576 /* create a list with metas, we don't know what order buffer_iterate has */
577 metas = g_list_prepend (g_list_prepend (g_list_prepend (NULL, m1), m2), m3);
580 m_found = gst_buffer_iterate_meta (buffer, &state);
581 fail_unless (m_found != NULL);
582 metas = g_list_remove (metas, m_found);
583 m_found = gst_buffer_iterate_meta (buffer, &state);
584 fail_unless (m_found != NULL);
585 metas = g_list_remove (metas, m_found);
586 m_found = gst_buffer_iterate_meta (buffer, &state);
587 fail_unless (m_found != NULL);
588 metas = g_list_remove (metas, m_found);
590 /* should only have 3 metas, so the 4th time we should get NULL back */
591 fail_unless (gst_buffer_iterate_meta (buffer, &state) == NULL);
593 /* list should be empty now, we should have seen each meta once */
594 fail_unless (metas == NULL);
596 /* same test as above with iterate_filtered */
598 /* create a list with metas, we don't know what order buffer_iterate has */
599 metas = g_list_prepend (g_list_prepend (g_list_prepend (NULL, m1), m2), m3);
603 gst_buffer_iterate_meta_filtered (buffer, &state, GST_META_TEST_API_TYPE);
604 fail_unless (m_found != NULL);
605 metas = g_list_remove (metas, m_found);
607 gst_buffer_iterate_meta_filtered (buffer, &state, GST_META_TEST_API_TYPE);
608 fail_unless (m_found != NULL);
609 metas = g_list_remove (metas, m_found);
611 /* should only have 2 Test metas, so now we should get NULL back */
612 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
613 GST_META_TEST_API_TYPE) == NULL);
615 /* but there should also still be a Foo meta */
616 fail_unless_equals_int (g_list_length (metas), 1);
617 fail_unless (metas->data == m2);
618 metas = g_list_remove (metas, m2);
622 gst_buffer_iterate_meta_filtered (buffer, &state, GST_META_FOO_API_TYPE);
623 fail_unless (m_found == m2);
625 /* only have 1 Foo meta, so now we should get NULL back */
626 fail_unless (gst_buffer_iterate_meta_filtered (buffer, &state,
627 GST_META_FOO_API_TYPE) == NULL);
629 gst_buffer_unref (buffer);
637 gst_buffermeta_suite (void)
639 Suite *s = suite_create ("GstMeta");
640 TCase *tc_chain = tcase_create ("general");
642 suite_add_tcase (s, tc_chain);
643 tcase_add_test (tc_chain, test_meta_test);
644 tcase_add_test (tc_chain, test_meta_locked);
645 tcase_add_test (tc_chain, test_meta_foreach_remove_one_of_one);
646 tcase_add_test (tc_chain, test_meta_foreach_remove_head_of_three);
647 tcase_add_test (tc_chain, test_meta_foreach_remove_middle_of_three);
648 tcase_add_test (tc_chain, test_meta_foreach_remove_tail_of_three);
649 tcase_add_test (tc_chain, test_meta_foreach_remove_head_and_tail_of_three);
650 tcase_add_test (tc_chain, test_meta_foreach_remove_several);
651 tcase_add_test (tc_chain, test_meta_iterate);
656 GST_CHECK_MAIN (gst_buffermeta);