/* GStreamer

 *

 * Common code for GStreamer unittests

 *

 * Copyright (C) 2004,2006 Thomas Vander Stichele <thomas at apestaart dot org>

 * Copyright (C) 2008 Thijs Vermeir <thijsvermeir@gmail.com>

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/**

 * SECTION:gstcheck

 * @short_description: Common code for GStreamer unit tests

 *

 * These macros and functions are for internal use of the unit tests found

 * inside the 'check' directories of various GStreamer packages.

 */

#include <string.h>

#include "gstcheck.h"

#include <glib_global.h>

GST_DEBUG_CATEGORY (check_debug);

/* logging function for tests

 * a test uses g_message() to log a debug line

 * a gst unit test can be run with GST_TEST_DEBUG env var set to see the

 * messages

 */

//gboolean _gst_check_threads_running = FALSE;

//GList *thread_list = NULL;

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(thread_list,gstcheck,GList*)

#define thread_list (*GET_GSTREAMER_WSD_VAR_NAME(thread_list,gstcheck,g)())

#else 

EXPORT_C GList *thread_list = NULL;

#endif

//GMutex *mutex;

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(mutex,gstcheck,GMutex*)

#define mutex (*GET_GSTREAMER_WSD_VAR_NAME(mutex,gstcheck,g)())

#else 

EXPORT_C GMutex *mutex = NULL;

#endif

//GCond *start_cond;              /* used to notify main thread of thread startups */

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(start_cond,gstcheck,GCond*)

#define start_cond (*GET_GSTREAMER_WSD_VAR_NAME(start_cond,gstcheck,g)())

#else 

EXPORT_C GCond *start_cond = NULL;

#endif

//GCond *sync_cond;               /* used to synchronize all threads and main thread */

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(sync_cond,gstcheck,GCond*)

#define sync_cond (*GET_GSTREAMER_WSD_VAR_NAME(sync_cond,gstcheck,g)())

#else 

EXPORT_C GCond *sync_cond = NULL;

#endif

//GList *buffers = NULL;

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(buffers,gstcheck,GList*)

#define buffers (*GET_GSTREAMER_WSD_VAR_NAME(buffers,gstcheck,g)())

#else 

EXPORT_C GList *buffers = NULL;

#endif

//GMutex *check_mutex = NULL;

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(check_mutex,gstcheck,GMutex *)

#define check_mutex (*GET_GSTREAMER_WSD_VAR_NAME(check_mutex,gstcheck,g)())

#else 

EXPORT_C GMutex *check_mutex = NULL;

#endif

//GCond *check_cond = NULL;

#if EMULATOR

GET_GLOBAL_VAR_FROM_TLS(check_cond,gstcheck,GCond *)

#define check_cond (*GET_GSTREAMER_WSD_VAR_NAME(check_cond,gstcheck,g)())

#else 

EXPORT_C GCond *check_cond = NULL;

#endif

/* FIXME 0.11: shouldn't _gst_check_debug be static? Not used anywhere */

EXPORT_C gboolean _gst_check_debug = FALSE;

#if EMULATOR

static GET_GLOBAL_VAR_FROM_TLS(raised_critical,gstcheck,gboolean)

#define _gst_check_raised_critical (*GET_GSTREAMER_WSD_VAR_NAME(raised_critical,gstcheck,g)())

#else 

EXPORT_C gboolean _gst_check_raised_critical = FALSE;

#endif

//gboolean _gst_check_raised_warning = FALSE;

#if EMULATOR

static GET_GLOBAL_VAR_FROM_TLS(raised_warning,gstcheck,gboolean)

#define _gst_check_raised_warning (*GET_GSTREAMER_WSD_VAR_NAME(raised_warning,gstcheck,g)())

#else 

EXPORT_C gboolean _gst_check_raised_warning = FALSE;

#endif

//gboolean _gst_check_expecting_log = FALSE;

#if EMULATOR

static GET_GLOBAL_VAR_FROM_TLS(expecting_log,gstcheck,gboolean)

#define _gst_check_expecting_log (*GET_GSTREAMER_WSD_VAR_NAME(expecting_log,gstcheck,g)())

#else 

EXPORT_C gboolean _gst_check_expecting_log = FALSE;

#endif

//gboolean _gst_check_expecting_log = FALSE;

#if EMULATOR

static GET_GLOBAL_VAR_FROM_TLS(threads_running,gstcheck,gboolean)

#define _gst_check_threads_running (*GET_GSTREAMER_WSD_VAR_NAME(threads_running,gstcheck,g)())

#else 

EXPORT_C gboolean _gst_check_threads_running = FALSE;

#endif

static void gst_check_log_message_func(const gchar * log_domain, GLogLevelFlags log_level,    const gchar * message, gpointer user_data)

{

  if (_gst_check_debug) {

    g_print ("%s", message);

  }

}

static void gst_check_log_critical_func

    (const gchar * log_domain, GLogLevelFlags log_level,

    const gchar * message, gpointer user_data)

{

  if (!_gst_check_expecting_log) {

    g_print ("\n\nUnexpected critical/warning: %s\n", message);

    fail ("Unexpected critical/warning: %s", message);

  }

  if (_gst_check_debug) {

    g_print ("\nExpected critical/warning: %s\n", message);

  }

  if (log_level & G_LOG_LEVEL_CRITICAL)

    _gst_check_raised_critical = TRUE;

  if (log_level & G_LOG_LEVEL_WARNING)

    _gst_check_raised_warning = TRUE;

}

/* initialize GStreamer testing */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_init (int *argc, char **argv[])

{

  gst_init (argc, argv);

  GST_DEBUG_CATEGORY_INIT (check_debug, "check", 0, "check regression tests");

  if (g_getenv ("GST_TEST_DEBUG"))

    _gst_check_debug = TRUE;

  g_log_set_handler (NULL, G_LOG_LEVEL_MESSAGE, gst_check_log_message_func,

      NULL);

  g_log_set_handler (NULL, G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING,

      gst_check_log_critical_func, NULL);

  g_log_set_handler ("GStreamer", G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING,

      gst_check_log_critical_func, NULL);

  g_log_set_handler ("GLib-GObject", G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING,

      gst_check_log_critical_func, NULL);

  g_log_set_handler ("Gst-Phonon", G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING,

      gst_check_log_critical_func, NULL);

  check_cond = g_cond_new ();

  check_mutex = g_mutex_new ();

}

/* message checking */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_message_error (GstMessage * message, GstMessageType type,

    GQuark domain, gint code)

{

  GError *error;

  gchar *debug;

  fail_unless (GST_MESSAGE_TYPE (message) == type,

      "message is of type %s instead of expected type %s",

      gst_message_type_get_name (GST_MESSAGE_TYPE (message)),

      gst_message_type_get_name (type));

  gst_message_parse_error (message, &error, &debug);

  fail_unless_equals_int (error->domain, domain);

  fail_unless_equals_int (error->code, code);

  g_error_free (error);

  g_free (debug);

}

/* helper functions */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstFlowReturn

gst_check_chain_func (GstPad * pad, GstBuffer * buffer)

{

  GST_DEBUG ("chain_func: received buffer %p", buffer);

  buffers = g_list_append (buffers, buffer);

  g_mutex_lock (check_mutex);

  g_cond_signal (check_cond);

  g_mutex_unlock (check_mutex);

  return GST_FLOW_OK;

}

/* setup an element for a filter test with mysrcpad and mysinkpad */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstElement *

gst_check_setup_element (const gchar * factory)

{

  GstElement *element;

  GST_DEBUG ("setup_element");

  element = gst_element_factory_make (factory, factory);

  fail_if (element == NULL, "Could not create a '%s' element", factory);

  ASSERT_OBJECT_REFCOUNT (element, factory, 1);

  return element;

}

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_teardown_element (GstElement * element)

{

  GST_DEBUG ("teardown_element");

  fail_unless (gst_element_set_state (element, GST_STATE_NULL) ==

      GST_STATE_CHANGE_SUCCESS, "could not set to null");

  ASSERT_OBJECT_REFCOUNT (element, "element", 1);

  gst_object_unref (element);

}

/* FIXME: set_caps isn't that useful

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstPad *

gst_check_setup_src_pad (GstElement * element,

    GstStaticPadTemplate * template, GstCaps * caps)

{

  GstPad *srcpad, *sinkpad;

  /* sending pad */

  srcpad = gst_pad_new_from_static_template (template, "src");

  GST_DEBUG_OBJECT (element, "setting up sending pad %p", srcpad);

  fail_if (srcpad == NULL, "Could not create a srcpad");

  ASSERT_OBJECT_REFCOUNT (srcpad, "srcpad", 1);

  fail_if (sinkpad == NULL, "Could not get sink pad from %s",

      GST_ELEMENT_NAME (element));

  ASSERT_OBJECT_REFCOUNT (sinkpad, "sinkpad", 2);

  fail_unless (gst_pad_link (srcpad, sinkpad) == GST_PAD_LINK_OK,

      "Could not link source and %s sink pads", GST_ELEMENT_NAME (element));

  gst_object_unref (sinkpad);   /* because we got it higher up */

  ASSERT_OBJECT_REFCOUNT (sinkpad, "sinkpad", 1);

  return srcpad;

}

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

{

  /* clean up floating src pad */

  /* pad refs held by both creator and this function (through _get) */

  /* one more ref is held by element itself */

}

/* FIXME: set_caps isn't that useful; might want to check if fixed,

 * then use set_use_fixed or somesuch */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

GstPad *

gst_check_setup_sink_pad (GstElement * element, GstStaticPadTemplate * template,

    GstCaps * caps)

{

  GstPad *srcpad, *sinkpad;

  /* receiving pad */

  sinkpad = gst_pad_new_from_static_template (template, "sink");

  GST_DEBUG_OBJECT (element, "setting up receiving pad %p", sinkpad);

  fail_if (sinkpad == NULL, "Could not create a sinkpad");

  fail_if (srcpad == NULL, "Could not get source pad from %s",

      GST_ELEMENT_NAME (element));

  gst_pad_set_chain_function (sinkpad, gst_check_chain_func);

  GST_DEBUG_OBJECT (element, "Linking element src pad and receiving sink pad");

  fail_unless (gst_pad_link (srcpad, sinkpad) == GST_PAD_LINK_OK,

      "Could not link %s source and sink pads", GST_ELEMENT_NAME (element));

  gst_object_unref (srcpad);    /* because we got it higher up */

  ASSERT_OBJECT_REFCOUNT (srcpad, "srcpad", 1);

  GST_DEBUG_OBJECT (element, "set up srcpad, refcount is 1");

  return sinkpad;

}

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_teardown_sink_pad (GstElement * element)

{

}

/**

 * gst_check_drop_buffers:

 *

 * Unref and remove all buffers that are in the global @buffers GList,

 * emptying the list.

 *

 * Since: 0.10.18

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_drop_buffers (void)

{

  GstBuffer *temp_buffer;

  while (g_list_length (buffers)) {

    temp_buffer = GST_BUFFER (buffers->data);

    gst_buffer_unref (temp_buffer);

    buffers = g_list_delete_link (buffers, buffers);

  }

}

/**

 * gst_check_caps_equal:

 * @caps1: first caps to compare

 * @caps2: second caps to compare

 *

 * Compare two caps with gst_caps_is_equal and fail unless they are

 * equal.

 *

 * Since: 0.10.18

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_caps_equal (GstCaps * caps1, GstCaps * caps2)

{

  gchar *name1 = gst_caps_to_string (caps1);

  gchar *name2 = gst_caps_to_string (caps2);

  fail_unless (gst_caps_is_equal (caps1, caps2),

      "caps ('%s') is not equal to caps ('%s')", name1, name2);

  g_free (name1);

  g_free (name2);

}

/**

 * gst_check_element_push_buffer:

 * @element: name of the element that needs to be created

 * @buffer_in: a list of buffers that needs to be puched to the element

 * @buffer_out: a list of buffers that we expect from the element

 * @last_flow_return: the last buffer push needs to give this GstFlowReturn

 *

 * Create an @element with the factory with the name and push the buffers in

 * @buffer_in to this element. The element should create the buffers equal to

 * the buffers in @buffer_out. We only check the caps, size and the data of the

 * buffers. This function unrefs the buffers in the two lists.

 * The last_flow_return parameter indicates the expected flow return value from

 * pushing the final buffer in the list.

 * This can be used to set up a test which pushes some buffers and then an

 * invalid buffer, when the final buffer is expected to fail, for example.

 * 

 * Since: 0.10.18

 */

#ifdef __SYMBIAN32__

EXPORT_C

#endif

void

gst_check_element_push_buffer_list (const gchar * element_name,

    GList * buffer_in, GList * buffer_out, GstFlowReturn last_flow_return)

{

  GstCaps *sink_caps;

  GstCaps *src_caps = NULL;

  GstElement *element;

  GstPad *pad_peer;

  GstPad *sink_pad = NULL;

  GstPad *src_pad;

  GstBuffer *buffer;

  /* check that there are no buffers waiting */

  gst_check_drop_buffers ();

  /* create the element */

  element = gst_check_setup_element (element_name);

  fail_if (element == NULL, "failed to create the element '%s'", element_name);

  fail_unless (GST_IS_ELEMENT (element), "the element is no element");

  /* create the src pad */

  buffer = GST_BUFFER (buffer_in->data);

  fail_unless (GST_IS_BUFFER (buffer), "There should be a buffer in buffer_in");

  src_caps = GST_BUFFER_CAPS (buffer);

  src_pad = gst_pad_new (NULL, GST_PAD_SRC);

  gst_pad_set_caps (src_pad, src_caps);