mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-27 10:40:34 +00:00
docs: add GstHarness to documentation
https://bugzilla.gnome.org/show_bug.cgi?id=751916
This commit is contained in:
Tim-Philipp Müller
parent
66e25da313
commit
49c896db3a
5 changed files with 140 additions and 3 deletions
|
|
@ -90,6 +90,7 @@
|
|||
<xi:include href="xml/gstcheck.xml" />
|
||||
<xi:include href="xml/gstcheckbufferstraw.xml" />
|
||||
<xi:include href="xml/gstcheckconsistencychecker.xml" />
|
||||
<xi:include href="xml/gstharness.xml" />
|
||||
<xi:include href="xml/gsttestclock.xml" />
|
||||
</chapter>
|
||||
</part>
|
||||
|
|
|
|||
|
|
@ -1198,6 +1198,116 @@ gst_consistency_checker_free
|
|||
gst_consistency_checker_add_pad
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstharness</FILE>
|
||||
<TITLE>GstHarness</TITLE>
|
||||
<INCLUDE>gst/check/check.h</INCLUDE>
|
||||
GstHarness
|
||||
|
||||
gst_harness_new_full
|
||||
gst_harness_new_with_element
|
||||
gst_harness_new_with_padnames
|
||||
gst_harness_new_with_templates
|
||||
gst_harness_new
|
||||
gst_harness_new_parse
|
||||
gst_harness_teardown
|
||||
|
||||
gst_harness_add_element_src_pad
|
||||
gst_harness_add_element_sink_pad
|
||||
|
||||
gst_harness_set_src_caps
|
||||
gst_harness_set_sink_caps
|
||||
gst_harness_set_caps
|
||||
gst_harness_set_src_caps_str
|
||||
gst_harness_set_sink_caps_str
|
||||
gst_harness_set_caps_str
|
||||
|
||||
gst_harness_use_systemclock
|
||||
gst_harness_use_testclock
|
||||
gst_harness_get_testclock
|
||||
gst_harness_set_time
|
||||
gst_harness_wait_for_clock_id_waits
|
||||
gst_harness_crank_single_clock_wait
|
||||
gst_harness_crank_multiple_clock_waits
|
||||
|
||||
gst_harness_play
|
||||
gst_harness_set_blocking_push_mode
|
||||
|
||||
gst_harness_create_buffer
|
||||
gst_harness_push
|
||||
gst_harness_pull
|
||||
gst_harness_try_pull
|
||||
gst_harness_push_and_pull
|
||||
gst_harness_buffers_received
|
||||
gst_harness_buffers_in_queue
|
||||
gst_harness_set_drop_buffers
|
||||
gst_harness_dump_to_file
|
||||
gst_harness_get_last_pushed_timestamp
|
||||
|
||||
gst_harness_push_event
|
||||
gst_harness_pull_event
|
||||
gst_harness_try_pull_event
|
||||
gst_harness_events_received
|
||||
gst_harness_events_in_queue
|
||||
|
||||
gst_harness_push_upstream_event
|
||||
gst_harness_pull_upstream_event
|
||||
gst_harness_try_pull_upstream_event
|
||||
gst_harness_upstream_events_received
|
||||
gst_harness_upstream_events_in_queue
|
||||
|
||||
gst_harness_query_latency
|
||||
gst_harness_set_upstream_latency
|
||||
|
||||
gst_harness_set_propose_allocator
|
||||
gst_harness_get_allocator
|
||||
|
||||
gst_harness_add_src
|
||||
gst_harness_add_src_parse
|
||||
gst_harness_push_from_src
|
||||
gst_harness_src_crank_and_push_many
|
||||
gst_harness_src_push_event
|
||||
|
||||
gst_harness_add_sink
|
||||
gst_harness_add_sink_parse
|
||||
gst_harness_push_to_sink
|
||||
gst_harness_sink_push_many
|
||||
|
||||
gst_harness_find_element
|
||||
gst_harness_set
|
||||
gst_harness_get
|
||||
gst_harness_add_probe
|
||||
|
||||
GstHarnessThread
|
||||
|
||||
gst_harness_stress_thread_stop
|
||||
gst_harness_stress_custom_start
|
||||
|
||||
gst_harness_stress_statechange_start
|
||||
gst_harness_stress_statechange_start_full
|
||||
|
||||
gst_harness_stress_push_buffer_start
|
||||
gst_harness_stress_push_buffer_start_full
|
||||
|
||||
GstHarnessPrepareBuffer
|
||||
gst_harness_stress_push_buffer_with_cb_start
|
||||
gst_harness_stress_push_buffer_with_cb_start_full
|
||||
|
||||
gst_harness_stress_push_event_start
|
||||
gst_harness_stress_push_event_start_full
|
||||
|
||||
gst_harness_stress_send_upstream_event_start
|
||||
gst_harness_stress_push_upstream_event_start_full
|
||||
|
||||
gst_harness_stress_property_start
|
||||
gst_harness_stress_property_start_full
|
||||
|
||||
gst_harness_stress_requestpad_start
|
||||
gst_harness_stress_requestpad_start_full
|
||||
<SUBSECTION Standard>
|
||||
GstHarnessPrivate
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gsttestclock</FILE>
|
||||
<TITLE>GstTestClock</TITLE>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@
|
|||
#include <gst/check/gstbufferstraw.h>
|
||||
#include <gst/check/gstcheck.h>
|
||||
#include <gst/check/gstconsistencychecker.h>
|
||||
#include <gst/check/gstharness.h>
|
||||
#include <gst/check/gsttestclock.h>
|
||||
|
||||
#endif /* __GST_CHECK__H__ */
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@
|
|||
* The basic structure of #GstHarness is two "floating" #GstPads, that connects
|
||||
* to the harnessed #GstElement src and sink #GstPads like so:
|
||||
*
|
||||
* <programlisting>
|
||||
* __________________________
|
||||
* _____ | _____ _____ | _____
|
||||
* | | | | | | | | | |
|
||||
|
|
@ -37,6 +38,7 @@
|
|||
* |_____| | |_____| |_____| | |_____|
|
||||
* |__________________________|
|
||||
*
|
||||
* </programlisting>
|
||||
*
|
||||
* With this, you can now simulate any environment the #GstElement might find
|
||||
* itself in. By specifying the #GstCaps of the harness #GstPads, using
|
||||
|
|
@ -1875,7 +1877,7 @@ gst_harness_get_allocator (GstHarness * h, GstAllocator ** allocator,
|
|||
|
||||
|
||||
/**
|
||||
* gst_harness_get_allocator:
|
||||
* gst_harness_set_propose_allocator:
|
||||
* @h: a #GstHarness
|
||||
* @allocator: (allow-none) (transfer full): a #GstAllocator
|
||||
* @params: (allow-none) (transfer none): a #GstAllocationParams
|
||||
|
|
@ -2225,6 +2227,8 @@ gst_harness_find_element (GstHarness * h, const gchar * element_name)
|
|||
* @h: a #GstHarness
|
||||
* @element_name: a #gchar with a #GstElementFactory name
|
||||
* @first_property_name: a #gchar with the first property name
|
||||
* @...: value for the first property, followed optionally by more
|
||||
* name/value pairs, followed by %NULL
|
||||
*
|
||||
* A convenience function to allows you to call g_object_set on a #GstElement
|
||||
* that are residing inside the #GstHarness, by using normal g_object_set
|
||||
|
|
@ -2251,6 +2255,8 @@ gst_harness_set (GstHarness * h,
|
|||
* @h: a #GstHarness
|
||||
* @element_name: a #gchar with a #GstElementFactory name
|
||||
* @first_property_name: a #gchar with the first property name
|
||||
* @...: return location for the first property, followed optionally by more
|
||||
* name/return location pairs, followed by %NULL
|
||||
*
|
||||
* A convenience function to allows you to call g_object_get on a #GstElement
|
||||
* that are residing inside the #GstHarness, by using normal g_object_get
|
||||
|
|
|
|||
|
|
@ -26,10 +26,28 @@
|
|||
|
||||
G_BEGIN_DECLS
|
||||
|
||||
typedef struct _GstHarness GstHarness;
|
||||
typedef struct _GstHarnessPrivate GstHarnessPrivate;
|
||||
/**
|
||||
* GstHarnessThread:
|
||||
*
|
||||
* Opaque handle representing a GstHarness stress testing thread.
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
typedef struct _GstHarnessThread GstHarnessThread;
|
||||
|
||||
typedef struct _GstHarness GstHarness;
|
||||
typedef struct _GstHarnessPrivate GstHarnessPrivate;
|
||||
|
||||
/**
|
||||
* GstHarness:
|
||||
* @element: the element inside the harness
|
||||
* @srcpad: the internal harness source pad
|
||||
* @sinkpad: the internal harness sink pad
|
||||
* @src_harness: the source (input) harness (if any)
|
||||
* @sink_harness: the sink (output) harness (if any)
|
||||
*
|
||||
* Since: 1.6
|
||||
*/
|
||||
struct _GstHarness {
|
||||
GstElement * element;
|
||||
|
||||
|
|
@ -39,6 +57,7 @@ struct _GstHarness {
|
|||
GstHarness * src_harness;
|
||||
GstHarness * sink_harness;
|
||||
|
||||
/*< private >*/
|
||||
GstHarnessPrivate * priv;
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue