libs/gst/check/gstbufferstraw.c

   1 /* GStreamer
   2  *
   3  * unit testing helper lib
   4  *
   5  * Copyright (C) 2006 Andy Wingo <wingo at pobox.com>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstcheckbufferstraw
  25  * @short_description: Buffer interception code for GStreamer unit tests
  26  *
  27  * These macros and functions are for internal use of the unit tests found
  28  * inside the 'check' directories of various GStreamer packages.
  29  */
  30
  31 #include "gstbufferstraw.h"
  32
  33 static GCond cond;
  34 static GMutex lock;
  35 static GstBuffer *buf = NULL;
  36 static gulong id;
  37
  38 /* called for every buffer.  Waits until the global "buf" variable is unset,
  39  * then sets it to the buffer received, and signals. */
  40 static GstPadProbeReturn
  41 buffer_probe (GstPad * pad, GstPadProbeInfo * info, gpointer unused)
  42 {
  43   GstBuffer *buffer = GST_PAD_PROBE_INFO_BUFFER (info);
  44
  45   g_mutex_lock (&lock);
  46
  47   while (buf != NULL)
  48     g_cond_wait (&cond, &lock);
  49
  50   /* increase the refcount because we store it globally for others to use */
  51   buf = gst_buffer_ref (buffer);
  52
  53   g_cond_signal (&cond);
  54
  55   g_mutex_unlock (&lock);
  56
  57   return GST_PAD_PROBE_OK;
  58 }
  59
  60 /**
  61  * gst_buffer_straw_start_pipeline:
  62  * @bin: the pipeline to run
  63  * @pad: a pad on an element in @bin
  64  *
  65  * Sets up a pipeline for buffer sucking. This will allow you to call
  66  * gst_buffer_straw_get_buffer() to access buffers as they pass over @pad.
  67  *
  68  * This function is normally used in unit tests that want to verify that a
  69  * particular element is outputting correct buffers. For example, you would make
  70  * a pipeline via gst_parse_launch(), pull out the pad you want to monitor, then
  71  * call gst_buffer_straw_get_buffer() to get the buffers that pass through @pad.
  72  * The pipeline will block until you have sucked off the buffers.
  73  *
  74  * This function will set the state of @bin to PLAYING; to clean up, be sure to
  75  * call gst_buffer_straw_stop_pipeline().
  76  *
  77  * Note that you may not start two buffer straws at the same time. This function
  78  * is intended for unit tests, not general API use. In fact it calls fail_if
  79  * from libcheck, so you cannot use it outside unit tests.
  80  */
  81 void
  82 gst_buffer_straw_start_pipeline (GstElement * bin, GstPad * pad)
  83 {
  84   GstStateChangeReturn ret;
  85
  86   id = gst_pad_add_probe (pad, GST_PAD_PROBE_TYPE_BUFFER,
  87       buffer_probe, NULL, NULL);
  88
  89   ret = gst_element_set_state (bin, GST_STATE_PLAYING);
  90   fail_if (ret == GST_STATE_CHANGE_FAILURE, "Could not start test pipeline");
  91   if (ret == GST_STATE_CHANGE_ASYNC) {
  92     ret = gst_element_get_state (bin, NULL, NULL, GST_CLOCK_TIME_NONE);
  93     fail_if (ret != GST_STATE_CHANGE_SUCCESS, "Could not start test pipeline");
  94   }
  95 }
  96
  97 /**
  98  * gst_buffer_straw_get_buffer:
  99  * @bin: the pipeline previously started via gst_buffer_straw_start_pipeline()
 100  * @pad: the pad previously passed to gst_buffer_straw_start_pipeline()
 101  *
 102  * Get one buffer from @pad. Implemented via buffer probes. This function will
 103  * block until the pipeline passes a buffer over @pad, so for robust behavior
 104  * in unit tests, you need to use check's timeout to fail out in the case that a
 105  * buffer never arrives.
 106  *
 107  * You must have previously called gst_buffer_straw_start_pipeline() on
 108  * @pipeline and @pad.
 109  *
 110  * Returns: the captured #GstBuffer.
 111  */
 112 GstBuffer *
 113 gst_buffer_straw_get_buffer (GstElement * bin, GstPad * pad)
 114 {
 115   GstBuffer *ret;
 116
 117   g_mutex_lock (&lock);
 118
 119   while (buf == NULL)
 120     g_cond_wait (&cond, &lock);
 121
 122   ret = buf;
 123   buf = NULL;
 124
 125   g_cond_signal (&cond);
 126
 127   g_mutex_unlock (&lock);
 128
 129   return ret;
 130 }
 131
 132 /**
 133  * gst_buffer_straw_stop_pipeline:
 134  * @bin: the pipeline previously started via gst_buffer_straw_start_pipeline()
 135  * @pad: the pad previously passed to gst_buffer_straw_start_pipeline()
 136  *
 137  * Set @bin to #GST_STATE_NULL and release resource allocated in
 138  * gst_buffer_straw_start_pipeline().
 139  *
 140  * You must have previously called gst_buffer_straw_start_pipeline() on
 141  * @pipeline and @pad.
 142  */
 143 void
 144 gst_buffer_straw_stop_pipeline (GstElement * bin, GstPad * pad)
 145 {
 146   GstStateChangeReturn ret;
 147
 148   g_mutex_lock (&lock);
 149   if (buf)
 150     gst_buffer_unref (buf);
 151   buf = NULL;
 152   gst_pad_remove_probe (pad, (guint) id);
 153   id = 0;
 154   g_cond_signal (&cond);
 155   g_mutex_unlock (&lock);
 156
 157   ret = gst_element_set_state (bin, GST_STATE_NULL);
 158   fail_if (ret == GST_STATE_CHANGE_FAILURE, "Could not stop test pipeline");
 159   if (ret == GST_STATE_CHANGE_ASYNC) {
 160     ret = gst_element_get_state (bin, NULL, NULL, GST_CLOCK_TIME_NONE);
 161     fail_if (ret != GST_STATE_CHANGE_SUCCESS, "Could not stop test pipeline");
 162   }
 163
 164   g_mutex_lock (&lock);
 165   if (buf)
 166     gst_buffer_unref (buf);
 167   buf = NULL;
 168   g_mutex_unlock (&lock);
 169 }