2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
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.
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.
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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_BASE_SINK_H__
24 #define __GST_BASE_SINK_H__
31 #define GST_TYPE_BASE_SINK (gst_base_sink_get_type())
32 #define GST_BASE_SINK(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_SINK,GstBaseSink))
33 #define GST_BASE_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_SINK,GstBaseSinkClass))
34 #define GST_BASE_SINK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_BASE_SINK, GstBaseSinkClass))
35 #define GST_IS_BASE_SINK(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_SINK))
36 #define GST_IS_BASE_SINK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_SINK))
37 #define GST_BASE_SINK_CAST(obj) ((GstBaseSink *) (obj))
41 * @obj: base sink instance
43 * Gives the pointer to the #GstPad object of the element.
45 #define GST_BASE_SINK_PAD(obj) (GST_BASE_SINK_CAST (obj)->sinkpad)
47 typedef struct _GstBaseSink GstBaseSink;
48 typedef struct _GstBaseSinkClass GstBaseSinkClass;
49 typedef struct _GstBaseSinkPrivate GstBaseSinkPrivate;
54 * The opaque #GstBaseSink data structure.
61 GstActivateMode pad_mode;
63 /*< protected >*/ /* with LOCK */
65 gboolean can_activate_pull;
66 gboolean can_activate_push;
68 /*< protected >*/ /* with PREROLL_LOCK */
69 GQueue *preroll_queue;
70 gint preroll_queue_max_len; /* FIXME-0.11: the property is guint */
76 gboolean need_preroll;
77 gboolean have_preroll;
78 gboolean playing_async;
80 /*< protected >*/ /* with STREAM_LOCK */
81 gboolean have_newsegment;
84 /*< private >*/ /* with LOCK */
86 GstClockTime end_time;
93 /* segment used for clipping incoming buffers */
94 GstSegment *clip_segment;
95 /* max amount of time a buffer can be late, -1 no limit. */
99 gpointer _gst_reserved[GST_PADDING_LARGE - 1];
102 GstBaseSinkPrivate *priv;
107 * @parent_class: Element parent class
108 * @get_caps: Called to get sink pad caps from the subclass
109 * @set_caps: Notify subclass of changed caps
110 * @buffer_alloc: Subclasses can override to perform custom buffer allocations
111 * @get_times: Called to get the start and end times for synchronising
112 * the passed buffer to the clock
113 * @start: Start processing. Ideal for opening resources in the subclass
114 * @stop: Stop processing. Subclasses should use this to close resources.
115 * @unlock: Unlock any pending access to the resource. Subclasses should
116 * unblock any blocked function ASAP
117 * @unlock_stop: Clear the previous unlock request. Subclasses should clear
118 * any state they set during unlock(), such as clearing command queues.
119 * @event: Override this to handle events arriving on the sink pad
120 * @preroll: Called to present the preroll buffer if desired
121 * @render: Called when a buffer should be presented or output, at the
122 * correct moment if the #GstBaseSink has been set to sync to the clock.
123 * @render_list: Same as @render but used whith buffer lists instead of
124 * buffers. Since: 0.10.24
125 * @async_play: Subclasses should override this when they need to perform
126 * special processing when changing to the PLAYING state asynchronously.
127 * Called with the OBJECT_LOCK held.
128 * @activate_pull: Subclasses should override this when they can provide an
129 * alternate method of spawning a thread to drive the pipeline in pull mode.
130 * Should start or stop the pulling thread, depending on the value of the
131 * "active" argument. Called after actually activating the sink pad in pull
132 * mode. The default implementation starts a task on the sink pad.
133 * @fixate: Only useful in pull mode, this vmethod will be called in response to
134 * gst_pad_fixate_caps() being called on the sink pad. Implement if you have
135 * ideas about what should be the default values for the caps you support.
136 * @query: perform a #GstQuery on the element. Since: 0.10.36
138 * Subclasses can override any of the available virtual methods or not, as
139 * needed. At the minimum, the @render method should be overridden to
140 * output/present buffers.
142 struct _GstBaseSinkClass {
143 GstElementClass parent_class;
145 /* get caps from subclass */
146 GstCaps* (*get_caps) (GstBaseSink *sink);
147 /* notify subclass of new caps */
148 gboolean (*set_caps) (GstBaseSink *sink, GstCaps *caps);
150 /* allocate a new buffer with given caps */
151 GstFlowReturn (*buffer_alloc) (GstBaseSink *sink, guint64 offset, guint size,
152 GstCaps *caps, GstBuffer **buf);
154 /* get the start and end times for syncing on this buffer */
155 void (*get_times) (GstBaseSink *sink, GstBuffer *buffer,
156 GstClockTime *start, GstClockTime *end);
158 /* start and stop processing, ideal for opening/closing the resource */
159 gboolean (*start) (GstBaseSink *sink);
160 gboolean (*stop) (GstBaseSink *sink);
162 /* unlock any pending access to the resource. subclasses should unlock
163 * any function ASAP. */
164 gboolean (*unlock) (GstBaseSink *sink);
166 /* notify subclass of event, preroll buffer or real buffer */
167 gboolean (*event) (GstBaseSink *sink, GstEvent *event);
168 GstFlowReturn (*preroll) (GstBaseSink *sink, GstBuffer *buffer);
169 GstFlowReturn (*render) (GstBaseSink *sink, GstBuffer *buffer);
173 /* when an ASYNC state change to PLAYING happens */ /* with LOCK */
174 GstStateChangeReturn (*async_play) (GstBaseSink *sink);
176 /* start or stop a pulling thread */
177 gboolean (*activate_pull)(GstBaseSink *sink, gboolean active);
179 /* fixate sink caps during pull-mode negotiation */
180 void (*fixate) (GstBaseSink *sink, GstCaps *caps);
182 /* Clear a previously indicated unlock request not that unlocking is
183 * complete. Sub-classes should clear any command queue or indicator they
184 * set during unlock */
185 gboolean (*unlock_stop) (GstBaseSink *sink);
187 /* Render a BufferList */
188 GstFlowReturn (*render_list) (GstBaseSink *sink, GstBufferList *buffer_list);
190 /* notify subclass of query */
191 gboolean (*query) (GstBaseSink *sink, GstQuery *query);
194 gpointer _gst_reserved[GST_PADDING_LARGE-6];
197 GType gst_base_sink_get_type(void);
199 GstFlowReturn gst_base_sink_do_preroll (GstBaseSink *sink, GstMiniObject *obj);
200 GstFlowReturn gst_base_sink_wait_preroll (GstBaseSink *sink);
202 /* synchronizing against the clock */
203 void gst_base_sink_set_sync (GstBaseSink *sink, gboolean sync);
204 gboolean gst_base_sink_get_sync (GstBaseSink *sink);
206 /* dropping late buffers */
207 void gst_base_sink_set_max_lateness (GstBaseSink *sink, gint64 max_lateness);
208 gint64 gst_base_sink_get_max_lateness (GstBaseSink *sink);
211 void gst_base_sink_set_qos_enabled (GstBaseSink *sink, gboolean enabled);
212 gboolean gst_base_sink_is_qos_enabled (GstBaseSink *sink);
214 /* doing async state changes */
215 void gst_base_sink_set_async_enabled (GstBaseSink *sink, gboolean enabled);
216 gboolean gst_base_sink_is_async_enabled (GstBaseSink *sink);
218 /* tuning synchronisation */
219 void gst_base_sink_set_ts_offset (GstBaseSink *sink, GstClockTimeDiff offset);
220 GstClockTimeDiff gst_base_sink_get_ts_offset (GstBaseSink *sink);
223 GstBuffer * gst_base_sink_get_last_buffer (GstBaseSink *sink);
224 void gst_base_sink_set_last_buffer_enabled (GstBaseSink *sink, gboolean enabled);
225 gboolean gst_base_sink_is_last_buffer_enabled (GstBaseSink *sink);
228 gboolean gst_base_sink_query_latency (GstBaseSink *sink, gboolean *live, gboolean *upstream_live,
229 GstClockTime *min_latency, GstClockTime *max_latency);
230 GstClockTime gst_base_sink_get_latency (GstBaseSink *sink);
233 void gst_base_sink_set_render_delay (GstBaseSink *sink, GstClockTime delay);
234 GstClockTime gst_base_sink_get_render_delay (GstBaseSink *sink);
237 void gst_base_sink_set_blocksize (GstBaseSink *sink, guint blocksize);
238 guint gst_base_sink_get_blocksize (GstBaseSink *sink);
241 void gst_base_sink_set_throttle_time (GstBaseSink *sink, guint64 throttle);
242 guint64 gst_base_sink_get_throttle_time (GstBaseSink *sink);
244 GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time,
245 GstClockTimeDiff * jitter);
246 GstFlowReturn gst_base_sink_wait_eos (GstBaseSink *sink, GstClockTime time,
247 GstClockTimeDiff *jitter);
251 #endif /* __GST_BASE_SINK_H__ */