2000-12-30 16:13:17 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GstScheduler
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2001-05-27 14:33:30 +00:00
|
|
|
An abstract class for plugable schedulers.
|
2000-12-30 16:13:17 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
This is a base class for custom schedulers.
|
2000-12-30 16:13:17 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-05-27 14:33:30 +00:00
|
|
|
<!-- ##### MACRO GST_SCHED_PARENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Get the parent #GstElement of this scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: the scheduler to query.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GstScheduleChain ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@disabled:
|
|
|
|
@elements:
|
|
|
|
@num_elements:
|
|
|
|
@entry:
|
|
|
|
@cothreaded_elements:
|
|
|
|
@schedule:
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Handy macro to check for a non NULL scheduler. The next block of statements
|
|
|
|
will only be axecuted if the scheduler is not NULL.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: the scheduler to query.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to add an element to the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler to add the element to.
|
|
|
|
@element: The element to add to the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to remove an element from the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler to remove the element from.
|
|
|
|
@element: The element to remove from the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to enable the element in the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@element: The element to activate.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to disable the element.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@element: The element to disable.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to lock a given element.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@element: The element to lock.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to unlock a given element.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@element: The element to unlock.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to connect two pads.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@srcpad: The source pad.
|
|
|
|
@sinkpad: The sink pad.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to disconnect two pads.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler.
|
|
|
|
@srcpad: The source pad.
|
|
|
|
@sinkpad: The sink pad.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### -->
|
|
|
|
<para>
|
2001-10-19 22:49:35 +00:00
|
|
|
Fast macro to perform one iteration of the scheduler.
|
2001-05-27 14:33:30 +00:00
|
|
|
</para>
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
@sched: The scheduler to iterate.
|
2001-05-27 14:33:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_new ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_add_element ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_remove_element ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_enable_element ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_disable_element ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@element:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_pad_connect ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@srcpad:
|
|
|
|
@sinkpad:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_pad_disconnect ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@srcpad:
|
|
|
|
@sinkpad:
|
|
|
|
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
<!-- ##### FUNCTION gst_schedule_pad_select ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@padlist:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-05-27 14:33:30 +00:00
|
|
|
<!-- ##### FUNCTION gst_schedule_iterate ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@sched:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gst_schedule_show ##### -->
|
2000-12-30 16:13:17 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-05-27 14:33:30 +00:00
|
|
|
@sched:
|
2000-12-30 16:13:17 +00:00
|
|
|
|
|
|
|
|