tests/check/elements/multifdsink.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2006 Thomas Vander Stichele <thomas at apestaart dot org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include <unistd.h>
  22 #include <sys/ioctl.h>
  23 #ifdef HAVE_FIONREAD_IN_SYS_FILIO
  24 #include <sys/filio.h>
  25 #endif
  26
  27 #include <gst/check/gstcheck.h>
  28
  29 GstPad *mysrcpad;
  30
  31 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  32     GST_PAD_SRC,
  33     GST_PAD_ALWAYS,
  34     GST_STATIC_CAPS ("application/x-gst-check")
  35     );
  36
  37 GstElement *
  38 setup_multifdsink ()
  39 {
  40   GstElement *multifdsink;
  41
  42   GST_DEBUG ("setup_multifdsink");
  43   multifdsink = gst_check_setup_element ("multifdsink");
  44   mysrcpad = gst_check_setup_src_pad (multifdsink, &srctemplate, NULL);
  45
  46   return multifdsink;
  47 }
  48
  49 void
  50 cleanup_multifdsink (GstElement * multifdsink)
  51 {
  52   GST_DEBUG ("cleanup_multifdsink");
  53
  54   gst_check_teardown_src_pad (multifdsink);
  55   gst_check_teardown_element (multifdsink);
  56 }
  57
  58 static void
  59 wait_bytes_served (GstElement * sink, guint64 bytes)
  60 {
  61   guint64 bytes_served = 0;
  62
  63   while (bytes_served != bytes) {
  64     g_object_get (sink, "bytes-served", &bytes_served, NULL);
  65   }
  66 }
  67
  68 /* FIXME: possibly racy, since if it would write, we may not get it
  69  * immediately ? */
  70 #define fail_if_can_read(msg,fd) \
  71 G_STMT_START { \
  72   long avail; \
  73 \
  74   fail_if (ioctl (fd, FIONREAD, &avail) < 0, "%s: could not ioctl", msg); \
  75   fail_if (avail > 0, "%s: has bytes available to read"); \
  76 } G_STMT_END;
  77
  78
  79 GST_START_TEST (test_no_clients)
  80 {
  81   GstElement *sink;
  82   GstBuffer *buffer;
  83   GstCaps *caps;
  84
  85   sink = setup_multifdsink ();
  86
  87   ASSERT_SET_STATE (sink, GST_STATE_PLAYING, GST_STATE_CHANGE_ASYNC);
  88
  89   caps = gst_caps_from_string ("application/x-gst-check");
  90   buffer = gst_buffer_new_and_alloc (4);
  91   gst_buffer_set_caps (buffer, caps);
  92   gst_caps_unref (caps);
  93   fail_unless (gst_pad_push (mysrcpad, buffer) == GST_FLOW_OK);
  94
  95   GST_DEBUG ("cleaning up multifdsink");
  96   ASSERT_SET_STATE (sink, GST_STATE_NULL, GST_STATE_CHANGE_SUCCESS);
  97   cleanup_multifdsink (sink);
  98 }
  99
 100 GST_END_TEST;
 101
 102 GST_START_TEST (test_add_client)
 103 {
 104   GstElement *sink;
 105   GstBuffer *buffer;
 106   GstCaps *caps;
 107   int pfd[2];
 108   gchar data[4];
 109   guint64 bytes_served;
 110
 111   sink = setup_multifdsink ();
 112
 113   fail_if (pipe (pfd) == -1);
 114
 115   ASSERT_SET_STATE (sink, GST_STATE_PLAYING, GST_STATE_CHANGE_ASYNC);
 116
 117   /* add the client */
 118   g_signal_emit_by_name (sink, "add", pfd[1]);
 119
 120   caps = gst_caps_from_string ("application/x-gst-check");
 121   GST_DEBUG ("Created test caps %p %" GST_PTR_FORMAT, caps, caps);
 122   buffer = gst_buffer_new_and_alloc (4);
 123   gst_buffer_set_caps (buffer, caps);
 124   ASSERT_CAPS_REFCOUNT (caps, "caps", 2);
 125   memcpy (GST_BUFFER_DATA (buffer), "dead", 4);
 126   fail_unless (gst_pad_push (mysrcpad, buffer) == GST_FLOW_OK);
 127
 128   fail_if (read (pfd[0], data, 4) < 4);
 129   fail_unless (strncmp (data, "dead", 4) == 0);
 130   wait_bytes_served (sink, 4);
 131
 132   GST_DEBUG ("cleaning up multifdsink");
 133   ASSERT_SET_STATE (sink, GST_STATE_NULL, GST_STATE_CHANGE_SUCCESS);
 134   cleanup_multifdsink (sink);
 135
 136   ASSERT_CAPS_REFCOUNT (caps, "caps", 1);
 137   gst_caps_unref (caps);
 138 }
 139
 140 GST_END_TEST;
 141
 142 #define fail_unless_read(msg,fd,size,ref) \
 143 G_STMT_START { \
 144   char data[size + 1]; \
 145   int nbytes; \
 146 \
 147   GST_DEBUG ("%s: reading %d bytes", msg, size); \
 148   nbytes = read (fd, data, size); \
 149   data[size] = 0; \
 150   GST_DEBUG ("%s: read %d bytes", msg, nbytes); \
 151   fail_if (nbytes < size); \
 152   fail_unless (memcmp (data, ref, size) == 0, \
 153       "data read '%s' differs from '%s'", data, ref); \
 154 } G_STMT_END;
 155
 156 /* from the given two data buffers, create two streamheader buffers and
 157  * some caps that match it, and store them in the given pointers
 158  * returns  one ref to each of the buffers and the caps */
 159 static void
 160 gst_multifdsink_create_streamheader (const gchar * data1,
 161     const gchar * data2, GstBuffer ** hbuf1, GstBuffer ** hbuf2,
 162     GstCaps ** caps)
 163 {
 164   GstBuffer *buf;
 165   GValue array = { 0 };
 166   GValue value = { 0 };
 167   GstStructure *structure;
 168   guint size1 = strlen (data1);
 169   guint size2 = strlen (data2);
 170
 171   fail_if (hbuf1 == NULL);
 172   fail_if (hbuf2 == NULL);
 173   fail_if (caps == NULL);
 174
 175   /* create caps with streamheader, set the caps, and push the IN_CAPS
 176    * buffers */
 177   *hbuf1 = gst_buffer_new_and_alloc (size1);
 178   GST_BUFFER_FLAG_SET (*hbuf1, GST_BUFFER_FLAG_IN_CAPS);
 179   memcpy (GST_BUFFER_DATA (*hbuf1), data1, size1);
 180   *hbuf2 = gst_buffer_new_and_alloc (size2);
 181   GST_BUFFER_FLAG_SET (*hbuf2, GST_BUFFER_FLAG_IN_CAPS);
 182   memcpy (GST_BUFFER_DATA (*hbuf2), data2, size2);
 183   /* we want to keep them around for the tests */
 184   gst_buffer_ref (*hbuf1);
 185   gst_buffer_ref (*hbuf2);
 186
 187   g_value_init (&array, GST_TYPE_ARRAY);
 188
 189   g_value_init (&value, GST_TYPE_BUFFER);
 190   /* we take a copy, set it on the array (which refs it), then unref our copy */
 191   buf = gst_buffer_copy (*hbuf1);
 192   gst_value_set_buffer (&value, buf);
 193   ASSERT_BUFFER_REFCOUNT (buf, "copied buffer", 2);
 194   gst_buffer_unref (buf);
 195   gst_value_array_append_value (&array, &value);
 196   g_value_unset (&value);
 197
 198   g_value_init (&value, GST_TYPE_BUFFER);
 199   buf = gst_buffer_copy (*hbuf2);
 200   gst_value_set_buffer (&value, buf);
 201   ASSERT_BUFFER_REFCOUNT (buf, "copied buffer", 2);
 202   gst_buffer_unref (buf);
 203   gst_value_array_append_value (&array, &value);
 204   g_value_unset (&value);
 205
 206   *caps = gst_caps_from_string ("application/x-gst-check");
 207   structure = gst_caps_get_structure (*caps, 0);
 208
 209   gst_structure_set_value (structure, "streamheader", &array);
 210   g_value_unset (&array);
 211   ASSERT_CAPS_REFCOUNT (*caps, "streamheader caps", 1);
 212
 213   /* set our streamheadery caps on the buffers */
 214   gst_buffer_set_caps (*hbuf1, *caps);
 215   gst_buffer_set_caps (*hbuf2, *caps);
 216   ASSERT_CAPS_REFCOUNT (*caps, "streamheader caps", 3);
 217
 218   GST_DEBUG ("created streamheader caps %p %" GST_PTR_FORMAT, *caps, *caps);
 219 }
 220
 221
 222 /* this test:
 223  * - adds a first client
 224  * - sets streamheader caps on the pad
 225  * - pushes the IN_CAPS buffers
 226  * - pushes a buffer
 227  * - verifies that the client received all the data correctly, and did not
 228  *   get multiple copies of the streamheader
 229  * - adds a second client
 230  * - verifies that this second client receives the streamheader caps too, plus
 231  * - the new buffer
 232  */
 233 GST_START_TEST (test_streamheader)
 234 {
 235   GstElement *sink;
 236   GstBuffer *hbuf1, *hbuf2, *buf;
 237   GstCaps *caps;
 238   GstStructure *structure;
 239   int pfd1[2], pfd2[2];
 240   guint8 data[12];
 241   guint64 bytes_served;
 242   int avail;
 243
 244   sink = setup_multifdsink ();
 245
 246   fail_if (pipe (pfd1) == -1);
 247   fail_if (pipe (pfd2) == -1);
 248
 249   ASSERT_SET_STATE (sink, GST_STATE_PLAYING, GST_STATE_CHANGE_ASYNC);
 250
 251   /* add the first client */
 252   g_signal_emit_by_name (sink, "add", pfd1[1]);
 253
 254   /* create caps with streamheader, set the caps, and push the IN_CAPS
 255    * buffers */
 256   gst_multifdsink_create_streamheader ("babe", "deadbeef", &hbuf1, &hbuf2,
 257       &caps);
 258   fail_unless (gst_pad_set_caps (mysrcpad, caps));
 259   /* one is ours, two on the buffers, and one now on the pad */
 260   ASSERT_CAPS_REFCOUNT (caps, "caps", 4);
 261
 262   fail_unless (gst_pad_push (mysrcpad, hbuf1) == GST_FLOW_OK);
 263   fail_unless (gst_pad_push (mysrcpad, hbuf2) == GST_FLOW_OK);
 264
 265   //FIXME:
 266   //fail_if_can_read ("first client", pfd1[0]);
 267
 268   /* push a non-IN_CAPS buffer, this should trigger the client receiving the
 269    * first three buffers */
 270   buf = gst_buffer_new_and_alloc (4);
 271   memcpy (GST_BUFFER_DATA (buf), "f00d", 4);
 272   gst_pad_push (mysrcpad, buf);
 273
 274   fail_unless_read ("first client", pfd1[0], 4, "babe");
 275   fail_unless_read ("first client", pfd1[0], 8, "deadbeef");
 276   fail_unless_read ("first client", pfd1[0], 4, "f00d");
 277   wait_bytes_served (sink, 16);
 278
 279   /* now add the second client */
 280   g_signal_emit_by_name (sink, "add", pfd2[1]);
 281   //FIXME:
 282   //fail_if_can_read ("second client", pfd2[0]);
 283
 284   /* now push another buffer, which will trigger streamheader for second
 285    * client */
 286   buf = gst_buffer_new_and_alloc (4);
 287   memcpy (GST_BUFFER_DATA (buf), "deaf", 4);
 288   gst_pad_push (mysrcpad, buf);
 289
 290   fail_unless_read ("first client", pfd1[0], 4, "deaf");
 291
 292   fail_unless_read ("second client", pfd2[0], 4, "babe");
 293   fail_unless_read ("second client", pfd2[0], 8, "deadbeef");
 294   /* we missed the f00d buffer */
 295   fail_unless_read ("second client", pfd2[0], 4, "deaf");
 296   wait_bytes_served (sink, 36);
 297
 298   GST_DEBUG ("cleaning up multifdsink");
 299
 300   g_signal_emit_by_name (sink, "remove", pfd1[1]);
 301   g_signal_emit_by_name (sink, "remove", pfd2[1]);
 302
 303   ASSERT_SET_STATE (sink, GST_STATE_NULL, GST_STATE_CHANGE_SUCCESS);
 304   cleanup_multifdsink (sink);
 305
 306   ASSERT_BUFFER_REFCOUNT (hbuf1, "hbuf1", 1);
 307   ASSERT_BUFFER_REFCOUNT (hbuf2, "hbuf2", 1);
 308   gst_buffer_unref (hbuf1);
 309   gst_buffer_unref (hbuf2);
 310
 311   ASSERT_CAPS_REFCOUNT (caps, "caps", 1);
 312   gst_caps_unref (caps);
 313 }
 314
 315 GST_END_TEST;
 316
 317 /* this tests changing of streamheaders
 318  * - set streamheader caps on the pad
 319  * - pushes the IN_CAPS buffers
 320  * - pushes a buffer
 321  * - add a first client
 322  * - verifies that this first client receives the first streamheader caps,
 323  *   plus a new buffer
 324  * - change streamheader caps
 325  * - verify that the first client receives the new streamheader buffers as well
 326  */
 327 GST_START_TEST (test_change_streamheader)
 328 {
 329   GstElement *sink;
 330   GstBuffer *hbuf1, *hbuf2, *buf;
 331   GstCaps *caps;
 332   GstStructure *structure;
 333   int pfd1[2], pfd2[2];
 334   guint8 data[12];
 335   GValue array = { 0 };
 336   GValue value = { 0 };
 337   guint64 bytes_served;
 338   int avail;
 339
 340   sink = setup_multifdsink ();
 341
 342   fail_if (pipe (pfd1) == -1);
 343   fail_if (pipe (pfd2) == -1);
 344
 345   ASSERT_SET_STATE (sink, GST_STATE_PLAYING, GST_STATE_CHANGE_ASYNC);
 346
 347   /* create caps with streamheader, set the caps, and push the IN_CAPS
 348    * buffers */
 349   gst_multifdsink_create_streamheader ("first", "header", &hbuf1, &hbuf2,
 350       &caps);
 351   fail_unless (gst_pad_set_caps (mysrcpad, caps));
 352   /* one is ours, two on the buffers, and one now on the pad */
 353   ASSERT_CAPS_REFCOUNT (caps, "caps", 4);
 354
 355   /* one to hold for the test and one to give away */
 356   ASSERT_BUFFER_REFCOUNT (hbuf1, "hbuf1", 2);
 357   ASSERT_BUFFER_REFCOUNT (hbuf2, "hbuf2", 2);
 358
 359   fail_unless (gst_pad_push (mysrcpad, hbuf1) == GST_FLOW_OK);
 360   fail_unless (gst_pad_push (mysrcpad, hbuf2) == GST_FLOW_OK);
 361
 362   /* add the first client */
 363   g_signal_emit_by_name (sink, "add", pfd1[1]);
 364
 365   /* verify this hasn't triggered a write yet */
 366   /* FIXME: possibly racy, since if it would write, we may not get it
 367    * immediately ? */
 368   fail_if_can_read ("first client, no buffer", pfd1[0]);
 369
 370   /* now push a buffer and read */
 371   buf = gst_buffer_new_and_alloc (4);
 372   memcpy (GST_BUFFER_DATA (buf), "f00d", 4);
 373   gst_pad_push (mysrcpad, buf);
 374
 375   fail_unless_read ("change: first client", pfd1[0], 5, "first");
 376   fail_unless_read ("change: first client", pfd1[0], 6, "header");
 377   fail_unless_read ("change: first client", pfd1[0], 4, "f00d");
 378   //wait_bytes_served (sink, 16);
 379
 380   /* now add the second client */
 381   g_signal_emit_by_name (sink, "add", pfd2[1]);
 382   fail_if_can_read ("second client, no buffer", pfd2[0]);
 383
 384   /* change the streamheader */
 385
 386   /* before we change, multifdsink still has a list of the old streamheaders */
 387   ASSERT_BUFFER_REFCOUNT (hbuf1, "hbuf1", 2);
 388   ASSERT_BUFFER_REFCOUNT (hbuf2, "hbuf2", 2);
 389   gst_buffer_unref (hbuf1);
 390   gst_buffer_unref (hbuf2);
 391
 392   /* drop our ref to the previous caps */
 393   gst_caps_unref (caps);
 394
 395   gst_multifdsink_create_streamheader ("second", "header", &hbuf1, &hbuf2,
 396       &caps);
 397   fail_unless (gst_pad_set_caps (mysrcpad, caps));
 398   /* one to hold for the test and one to give away */
 399   ASSERT_BUFFER_REFCOUNT (hbuf1, "hbuf1", 2);
 400   ASSERT_BUFFER_REFCOUNT (hbuf2, "hbuf2", 2);
 401
 402   fail_unless (gst_pad_push (mysrcpad, hbuf1) == GST_FLOW_OK);
 403   fail_unless (gst_pad_push (mysrcpad, hbuf2) == GST_FLOW_OK);
 404
 405   /* verify neither client has new data available to read */
 406   fail_if_can_read ("first client, changed streamheader", pfd1[0]);
 407   fail_if_can_read ("second client, changed streamheader", pfd2[0]);
 408
 409   /* now push another buffer, which will trigger streamheader for second
 410    * client, but should also send new streamheaders to first client */
 411   buf = gst_buffer_new_and_alloc (8);
 412   memcpy (GST_BUFFER_DATA (buf), "deadbabe", 8);
 413   gst_pad_push (mysrcpad, buf);
 414
 415   fail_unless_read ("first client", pfd1[0], 6, "second");
 416   fail_unless_read ("first client", pfd1[0], 6, "header");
 417   fail_unless_read ("first client", pfd1[0], 8, "deadbabe");
 418
 419   /* new streamheader data */
 420   fail_unless_read ("second client", pfd2[0], 6, "second");
 421   fail_unless_read ("second client", pfd2[0], 6, "header");
 422   /* we missed the f00d buffer */
 423   fail_unless_read ("second client", pfd2[0], 8, "deadbabe");
 424   //wait_bytes_served (sink, 36);
 425
 426   GST_DEBUG ("cleaning up multifdsink");
 427   g_signal_emit_by_name (sink, "remove", pfd1[1]);
 428   g_signal_emit_by_name (sink, "remove", pfd2[1]);
 429   ASSERT_SET_STATE (sink, GST_STATE_NULL, GST_STATE_CHANGE_SUCCESS);
 430
 431   /* setting to NULL should have cleared the streamheader */
 432   ASSERT_BUFFER_REFCOUNT (hbuf1, "hbuf1", 1);
 433   ASSERT_BUFFER_REFCOUNT (hbuf2, "hbuf2", 1);
 434   gst_buffer_unref (hbuf1);
 435   gst_buffer_unref (hbuf2);
 436   cleanup_multifdsink (sink);
 437
 438   ASSERT_CAPS_REFCOUNT (caps, "caps", 1);
 439   gst_caps_unref (caps);
 440 }
 441
 442 GST_END_TEST;
 443
 444 /* FIXME: add test simulating chained oggs where:
 445  * sync-method is burst-on-connect
 446  * (when multifdsink actually does burst-on-connect based on byte size, not
 447    "last keyframe" which any frame for audio :))
 448  * an old client still needs to read from before the new streamheaders
 449  * a new client gets the new streamheaders
 450  */
 451
 452 Suite *
 453 multifdsink_suite (void)
 454 {
 455   Suite *s = suite_create ("multifdsink");
 456   TCase *tc_chain = tcase_create ("general");
 457
 458   suite_add_tcase (s, tc_chain);
 459   tcase_add_test (tc_chain, test_no_clients);
 460   tcase_add_test (tc_chain, test_add_client);
 461   tcase_add_test (tc_chain, test_streamheader);
 462   tcase_add_test (tc_chain, test_change_streamheader);
 463
 464   return s;
 465 }
 466
 467 int
 468 main (int argc, char **argv)
 469 {
 470   int nf;
 471
 472   Suite *s = multifdsink_suite ();
 473   SRunner *sr = srunner_create (s);
 474
 475   gst_check_init (&argc, &argv);
 476
 477   srunner_run_all (sr, CK_NORMAL);
 478   nf = srunner_ntests_failed (sr);
 479   srunner_free (sr);
 480
 481   return nf;
 482 }