check: Add GstHarness convenience API for unit tests

http://gstconf.ubicast.tv/videos/gstharness-again-a-follow-up/

https://bugzilla.gnome.org/show_bug.cgi?id=751916
This commit is contained in:
Havard Graff 2013-12-16 10:47:47 +01:00 committed by Tim-Philipp Müller
parent 274f4b784a
commit 66e25da313
3 changed files with 3153 additions and 0 deletions

View file

@ -9,6 +9,7 @@ libgstcheck_@GST_API_VERSION@_la_SOURCES = \
gstbufferstraw.c \
gstcheck.c \
gstconsistencychecker.c \
gstharness.c \
gsttestclock.c
libgstcheck_@GST_API_VERSION@_la_CFLAGS = $(GST_OBJ_CFLAGS) \
@ -29,6 +30,7 @@ libgstcheck_@GST_API_VERSION@include_HEADERS = \
gstbufferstraw.h \
gstcheck.h \
gstconsistencychecker.h \
gstharness.h \
gsttestclock.h
nodist_libgstcheck_@GST_API_VERSION@include_HEADERS = \
@ -93,6 +95,75 @@ LIBGSTCHECK_EXPORTED_FUNCS = \
gst_consistency_checker_new \
gst_consistency_checker_reset \
gst_consistency_checker_free \
gst_harness_add_element_src_pad \
gst_harness_add_probe \
gst_harness_add_sink \
gst_harness_add_sink_parse \
gst_harness_add_src \
gst_harness_add_src_parse \
gst_harness_buffers_received \
gst_harness_buffers_in_queue \
gst_harness_crank_multiple_clock_waits \
gst_harness_crank_single_clock_wait \
gst_harness_create_buffer \
gst_harness_dump_to_file \
gst_harness_events_received \
gst_harness_events_in_queue \
gst_harness_find_element \
gst_harness_get \
gst_harness_get_allocator \
gst_harness_get_last_pushed_timestamp \
gst_harness_get_testclock \
gst_harness_new \
gst_harness_new_full \
gst_harness_new_parse \
gst_harness_new_with_element \
gst_harness_new_with_padnames \
gst_harness_new_with_templates \
gst_harness_play \
gst_harness_pull \
gst_harness_pull_event \
gst_harness_pull_upstream_event \
gst_harness_push \
gst_harness_push_and_pull \
gst_harness_push_event \
gst_harness_push_from_src \
gst_harness_push_to_sink \
gst_harness_query_latency \
gst_harness_push_upstream_event \
gst_harness_set \
gst_harness_set_caps \
gst_harness_set_caps_str \
gst_harness_set_drop_buffers \
gst_harness_set_blocking_push_mode \
gst_harness_set_propose_allocator \
gst_harness_set_sink_caps \
gst_harness_set_src_caps \
gst_harness_set_src_caps_str \
gst_harness_set_sink_caps_str \
gst_harness_set_time \
gst_harness_set_upstream_latency \
gst_harness_sink_push_many \
gst_harness_src_crank_and_push_many \
gst_harness_src_push_event \
gst_harness_stress_custom_start \
gst_harness_stress_property_start_full \
gst_harness_stress_push_buffer_start_full \
gst_harness_stress_push_buffer_with_cb_start_full \
gst_harness_stress_push_event_start_full \
gst_harness_stress_push_upstream_event_start_full \
gst_harness_stress_requestpad_start_full \
gst_harness_stress_statechange_start_full \
gst_harness_stress_thread_stop \
gst_harness_teardown \
gst_harness_try_pull \
gst_harness_try_pull_event \
gst_harness_try_pull_upstream_event \
gst_harness_upstream_events_received \
gst_harness_upstream_events_in_queue \
gst_harness_use_systemclock \
gst_harness_use_testclock \
gst_harness_wait_for_clock_id_waits \
gst_test_clock_get_type \
gst_test_clock_new \
gst_test_clock_new_with_start_time \

2885
libs/gst/check/gstharness.c Normal file

File diff suppressed because it is too large Load diff

197
libs/gst/check/gstharness.h Normal file
View file

@ -0,0 +1,197 @@
/* GstHarness - A test-harness for GStreamer testing
*
* Copyright (C) 2012-2015 Pexip <pexip.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.
*/
#ifndef __GST_HARNESS_H__
#define __GST_HARNESS_H__
#include <gst/gst.h>
#include <gst/check/gsttestclock.h>
G_BEGIN_DECLS
typedef struct _GstHarness GstHarness;
typedef struct _GstHarnessPrivate GstHarnessPrivate;
typedef struct _GstHarnessThread GstHarnessThread;
struct _GstHarness {
GstElement * element;
GstPad * srcpad;
GstPad * sinkpad;
GstHarness * src_harness;
GstHarness * sink_harness;
GstHarnessPrivate * priv;
};
/* Harness creation */
GstHarness * gst_harness_new_full (GstElement * element,
GstStaticPadTemplate * hsrc, const gchar * sinkpad,
GstStaticPadTemplate * hsink, const gchar * srcpad);
GstHarness * gst_harness_new_with_element (GstElement * element,
const gchar * sinkpad, const gchar * srcpad);
GstHarness * gst_harness_new_with_padnames (const gchar * element_name,
const gchar * sinkpad, const gchar * srcpad);
GstHarness * gst_harness_new_with_templates (const gchar * element_name,
GstStaticPadTemplate * hsrc, GstStaticPadTemplate * hsink);
GstHarness * gst_harness_new (const gchar * element_name);
GstHarness * gst_harness_new_parse (const gchar * launchline);
void gst_harness_teardown (GstHarness * h);
void gst_harness_add_element_src_pad (GstHarness * h, GstPad * srcpad);
void gst_harness_add_element_sink_pad (GstHarness * h, GstPad * sinkpad);
/* Caps Functions */
void gst_harness_set_src_caps (GstHarness * h, GstCaps * caps);
void gst_harness_set_sink_caps (GstHarness * h, GstCaps * caps);
void gst_harness_set_caps (GstHarness * h, GstCaps * in, GstCaps * out);
void gst_harness_set_src_caps_str (GstHarness * h, const gchar * str);
void gst_harness_set_sink_caps_str (GstHarness * h, const gchar * str);
void gst_harness_set_caps_str (GstHarness * h,
const gchar * in, const gchar * out);
/* Clock Functions */
void gst_harness_use_systemclock (GstHarness * h);
void gst_harness_use_testclock (GstHarness * h);
GstTestClock * gst_harness_get_testclock (GstHarness * h);
gboolean gst_harness_set_time (GstHarness * h, GstClockTime time);
gboolean gst_harness_wait_for_clock_id_waits (GstHarness * h,
guint waits, guint timeout);
gboolean gst_harness_crank_single_clock_wait (GstHarness * h);
gboolean gst_harness_crank_multiple_clock_waits (GstHarness * h,
guint waits);
void gst_harness_play (GstHarness * h);
void gst_harness_set_blocking_push_mode (GstHarness * h);
/* buffers */
GstBuffer * gst_harness_create_buffer (GstHarness * h, gsize size);
GstFlowReturn gst_harness_push (GstHarness * h, GstBuffer * buffer);
GstBuffer * gst_harness_pull (GstHarness * h);
GstBuffer * gst_harness_try_pull (GstHarness * h);
GstBuffer * gst_harness_push_and_pull (GstHarness * h, GstBuffer * buffer);
guint gst_harness_buffers_received (GstHarness * h);
guint gst_harness_buffers_in_queue (GstHarness * h);
void gst_harness_set_drop_buffers (GstHarness * h, gboolean drop_buffers);
void gst_harness_dump_to_file (GstHarness * h, const gchar * filename);
GstClockTime gst_harness_get_last_pushed_timestamp (GstHarness * h);
/* downstream events */
gboolean gst_harness_push_event (GstHarness * h, GstEvent * event);
GstEvent * gst_harness_pull_event (GstHarness * h);
GstEvent * gst_harness_try_pull_event (GstHarness * h);
guint gst_harness_events_received (GstHarness * h);
guint gst_harness_events_in_queue (GstHarness * h);
/* upstream events */
gboolean gst_harness_push_upstream_event (GstHarness * h, GstEvent * event);
GstEvent * gst_harness_pull_upstream_event (GstHarness * h);
GstEvent * gst_harness_try_pull_upstream_event (GstHarness * h);
guint gst_harness_upstream_events_received (GstHarness * h);
guint gst_harness_upstream_events_in_queue (GstHarness * h);
/* latency */
GstClockTime gst_harness_query_latency (GstHarness * h);
void gst_harness_set_upstream_latency (GstHarness * h, GstClockTime latency);
/* allocator and allocation params */
void gst_harness_set_propose_allocator (GstHarness * h, GstAllocator * allocator,
const GstAllocationParams * params);
void gst_harness_get_allocator (GstHarness * h, GstAllocator ** allocator,
GstAllocationParams * params);
/* src-harness */
void gst_harness_add_src (GstHarness * h,
const gchar * src_element_name, gboolean has_clock_wait);
void gst_harness_add_src_parse (GstHarness * h,
const gchar * launchline, gboolean has_clock_wait);
GstFlowReturn gst_harness_push_from_src (GstHarness * h);
GstFlowReturn gst_harness_src_crank_and_push_many (GstHarness * h,
gint cranks, gint pushes);
gboolean gst_harness_src_push_event (GstHarness * h);
/* sink-harness */
void gst_harness_add_sink (GstHarness * h,
const gchar * sink_element_name);
void gst_harness_add_sink_parse (GstHarness * h,
const gchar * launchline);
GstFlowReturn gst_harness_push_to_sink (GstHarness * h);
GstFlowReturn gst_harness_sink_push_many (GstHarness * h, gint pushes);
/* convenience functions */
GstElement * gst_harness_find_element (GstHarness * h,
const gchar * element_name);
void gst_harness_set (GstHarness * h,
const gchar * element_name, const gchar * first_property_name, ...);
void gst_harness_get (GstHarness * h,
const gchar * element_name, const gchar * first_property_name, ...);
void gst_harness_add_probe (GstHarness * h,
const gchar * element_name, const gchar * pad_name, GstPadProbeType mask,
GstPadProbeCallback callback, gpointer user_data,
GDestroyNotify destroy_data);
/* Stress */
guint gst_harness_stress_thread_stop (GstHarnessThread * t);
GstHarnessThread * gst_harness_stress_custom_start (GstHarness * h,
GFunc init, GFunc callback, gpointer data, gulong sleep);
#define gst_harness_stress_statechange_start(h) \
gst_harness_stress_statechange_start_full (h, G_USEC_PER_SEC / 100)
GstHarnessThread * gst_harness_stress_statechange_start_full (GstHarness * h,
gulong sleep);
#define gst_harness_stress_push_buffer_start(h, c, s, b) \
gst_harness_stress_push_buffer_start_full (h, c, s, b, 0)
GstHarnessThread * gst_harness_stress_push_buffer_start_full (GstHarness * h,
GstCaps * caps, const GstSegment * segment, GstBuffer * buf, gulong sleep);
typedef GstBuffer * (*GstHarnessPrepareBuffer) (GstHarness * h, gpointer data);
#define gst_harness_stress_push_buffer_with_cb_start(h, c, s, f, d, n) \
gst_harness_stress_push_buffer_with_cb_start_full (h, c, s, f, d, n, 0)
GstHarnessThread * gst_harness_stress_push_buffer_with_cb_start_full (
GstHarness * h, GstCaps * caps, const GstSegment * segment,
GstHarnessPrepareBuffer func, gpointer data, GDestroyNotify notify,
gulong sleep);
#define gst_harness_stress_push_event_start(h, e) \
gst_harness_stress_push_event_start_full (h, e, 0)
GstHarnessThread * gst_harness_stress_push_event_start_full (GstHarness * h,
GstEvent * event, gulong sleep);
#define gst_harness_stress_send_upstream_event_start(h, e) \
gst_harness_stress_push_upstream_event_start_full (h, e, 0)
GstHarnessThread * gst_harness_stress_push_upstream_event_start_full (
GstHarness * h, GstEvent * event, gulong sleep);
#define gst_harness_stress_property_start(h, n, v) \
gst_harness_stress_property_start_full (h, n, v, G_USEC_PER_SEC / 1000)
GstHarnessThread * gst_harness_stress_property_start_full (GstHarness * h,
const gchar * name, const GValue * value, gulong sleep);
#define gst_harness_stress_requestpad_start(h, t, n, c, r) \
gst_harness_stress_requestpad_start_full (h, t, n, c, r, G_USEC_PER_SEC / 100)
GstHarnessThread * gst_harness_stress_requestpad_start_full (GstHarness * h,
GstPadTemplate * templ, const gchar * name, GstCaps * caps,
gboolean release, gulong sleep);
G_END_DECLS
#endif /* __GST_HARNESS_H__ */