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 #define GST_BASE_SINK_GET_PREROLL_LOCK(pad) (&GST_BASE_SINK_CAST(pad)->preroll_lock)
48 #define GST_BASE_SINK_PREROLL_LOCK(pad) (g_mutex_lock(GST_BASE_SINK_GET_PREROLL_LOCK(pad)))
49 #define GST_BASE_SINK_PREROLL_TRYLOCK(pad) (g_mutex_trylock(GST_BASE_SINK_GET_PREROLL_LOCK(pad)))
50 #define GST_BASE_SINK_PREROLL_UNLOCK(pad) (g_mutex_unlock(GST_BASE_SINK_GET_PREROLL_LOCK(pad)))
52 #define GST_BASE_SINK_GET_PREROLL_COND(pad) (&GST_BASE_SINK_CAST(pad)->preroll_cond)
53 #define GST_BASE_SINK_PREROLL_WAIT(pad) \
54 g_cond_wait (GST_BASE_SINK_GET_PREROLL_COND (pad), GST_BASE_SINK_GET_PREROLL_LOCK (pad))
55 #define GST_BASE_SINK_PREROLL_WAIT_UNTIL(pad, end_time) \
56 g_cond_wait_until (GST_BASE_SINK_GET_PREROLL_COND (pad), GST_BASE_SINK_GET_PREROLL_LOCK (pad), end_time)
57 #define GST_BASE_SINK_PREROLL_SIGNAL(pad) g_cond_signal (GST_BASE_SINK_GET_PREROLL_COND (pad));
58 #define GST_BASE_SINK_PREROLL_BROADCAST(pad) g_cond_broadcast (GST_BASE_SINK_GET_PREROLL_COND (pad));
60 typedef struct _GstBaseSink GstBaseSink;
61 typedef struct _GstBaseSinkClass GstBaseSinkClass;
62 typedef struct _GstBaseSinkPrivate GstBaseSinkPrivate;
67 * The opaque #GstBaseSink data structure.
76 /*< protected >*/ /* with LOCK */
78 gboolean can_activate_pull;
79 gboolean can_activate_push;
81 /*< protected >*/ /* with PREROLL_LOCK */
85 gboolean need_preroll;
86 gboolean have_preroll;
87 gboolean playing_async;
89 /*< protected >*/ /* with STREAM_LOCK */
90 gboolean have_newsegment;
93 /*< private >*/ /* with LOCK */
102 GstBaseSinkPrivate *priv;
104 gpointer _gst_reserved[GST_PADDING_LARGE];
109 * @parent_class: Element parent class
110 * @get_caps: Called to get sink pad caps from the subclass
111 * @set_caps: Notify subclass of changed caps
112 * @fixate: Only useful in pull mode. Implement if you have
113 * ideas about what should be the default values for the caps you support.
114 * @activate_pull: Subclasses should override this when they can provide an
115 * alternate method of spawning a thread to drive the pipeline in pull mode.
116 * Should start or stop the pulling thread, depending on the value of the
117 * "active" argument. Called after actually activating the sink pad in pull
118 * mode. The default implementation starts a task on the sink pad.
119 * @get_times: Called to get the start and end times for synchronising
120 * the passed buffer to the clock
121 * @propose_allocation: configure the allocation query
122 * @start: Start processing. Ideal for opening resources in the subclass
123 * @stop: Stop processing. Subclasses should use this to close resources.
124 * @unlock: Unlock any pending access to the resource. Subclasses should
125 * unblock any blocked function ASAP
126 * @unlock_stop: Clear the previous unlock request. Subclasses should clear
127 * any state they set during unlock(), such as clearing command queues.
128 * @query: perform a #GstQuery on the element. Since: 0.10.36
129 * @event: Override this to handle events arriving on the sink pad
130 * @wait_eos: Override this to implement custom logic to wait for the EOS time.
131 * subclasses should always first chain up to the default implementation.
132 * @prepare: Called to prepare the buffer for @render and @preroll. This
133 * function is called before synchronisation is performed.
134 * @prepare_list: Called to prepare the buffer list for @render_list. This
135 * function is called before synchronisation is performed.
136 * @preroll: Called to present the preroll buffer if desired.
137 * @render: Called when a buffer should be presented or output, at the
138 * correct moment if the #GstBaseSink has been set to sync to the clock.
139 * @render_list: Same as @render but used whith buffer lists instead of
140 * buffers. Since: 0.10.24
142 * Subclasses can override any of the available virtual methods or not, as
143 * needed. At the minimum, the @render method should be overridden to
144 * output/present buffers.
146 struct _GstBaseSinkClass {
147 GstElementClass parent_class;
149 /* get caps from subclass */
150 GstCaps* (*get_caps) (GstBaseSink *sink, GstCaps *filter);
151 /* notify subclass of new caps */
152 gboolean (*set_caps) (GstBaseSink *sink, GstCaps *caps);
154 /* fixate sink caps during pull-mode negotiation */
155 GstCaps * (*fixate) (GstBaseSink *sink, GstCaps *caps);
156 /* start or stop a pulling thread */
157 gboolean (*activate_pull)(GstBaseSink *sink, gboolean active);
159 /* get the start and end times for syncing on this buffer */
160 void (*get_times) (GstBaseSink *sink, GstBuffer *buffer,
161 GstClockTime *start, GstClockTime *end);
163 /* propose allocation parameters for upstream */
164 gboolean (*propose_allocation) (GstBaseSink *sink, GstQuery *query);
166 /* start and stop processing, ideal for opening/closing the resource */
167 gboolean (*start) (GstBaseSink *sink);
168 gboolean (*stop) (GstBaseSink *sink);
170 /* unlock any pending access to the resource. subclasses should unlock
171 * any function ASAP. */
172 gboolean (*unlock) (GstBaseSink *sink);
173 /* Clear a previously indicated unlock request not that unlocking is
174 * complete. Sub-classes should clear any command queue or indicator they
175 * set during unlock */
176 gboolean (*unlock_stop) (GstBaseSink *sink);
178 /* notify subclass of query */
179 gboolean (*query) (GstBaseSink *sink, GstQuery *query);
181 /* notify subclass of event */
182 gboolean (*event) (GstBaseSink *sink, GstEvent *event);
183 /* wait for eos, subclasses should chain up to parent first */
184 GstFlowReturn (*wait_eos) (GstBaseSink *sink, GstEvent *event);
186 /* notify subclass of buffer or list before doing sync */
187 GstFlowReturn (*prepare) (GstBaseSink *sink, GstBuffer *buffer);
188 GstFlowReturn (*prepare_list) (GstBaseSink *sink, GstBufferList *buffer_list);
190 /* notify subclass of preroll buffer or real buffer */
191 GstFlowReturn (*preroll) (GstBaseSink *sink, GstBuffer *buffer);
192 GstFlowReturn (*render) (GstBaseSink *sink, GstBuffer *buffer);
193 /* Render a BufferList */
194 GstFlowReturn (*render_list) (GstBaseSink *sink, GstBufferList *buffer_list);
197 gpointer _gst_reserved[GST_PADDING_LARGE];
200 GType gst_base_sink_get_type(void);
202 GstFlowReturn gst_base_sink_do_preroll (GstBaseSink *sink, GstMiniObject *obj);
203 GstFlowReturn gst_base_sink_wait_preroll (GstBaseSink *sink);
205 /* synchronizing against the clock */
206 void gst_base_sink_set_sync (GstBaseSink *sink, gboolean sync);
207 gboolean gst_base_sink_get_sync (GstBaseSink *sink);
209 /* dropping late buffers */
210 void gst_base_sink_set_max_lateness (GstBaseSink *sink, gint64 max_lateness);
211 gint64 gst_base_sink_get_max_lateness (GstBaseSink *sink);
214 void gst_base_sink_set_qos_enabled (GstBaseSink *sink, gboolean enabled);
215 gboolean gst_base_sink_is_qos_enabled (GstBaseSink *sink);
217 /* doing async state changes */
218 void gst_base_sink_set_async_enabled (GstBaseSink *sink, gboolean enabled);
219 gboolean gst_base_sink_is_async_enabled (GstBaseSink *sink);
221 /* tuning synchronisation */
222 void gst_base_sink_set_ts_offset (GstBaseSink *sink, GstClockTimeDiff offset);
223 GstClockTimeDiff gst_base_sink_get_ts_offset (GstBaseSink *sink);
226 GstSample * gst_base_sink_get_last_sample (GstBaseSink *sink);
227 void gst_base_sink_set_last_sample_enabled (GstBaseSink *sink, gboolean enabled);
228 gboolean gst_base_sink_is_last_sample_enabled (GstBaseSink *sink);
231 gboolean gst_base_sink_query_latency (GstBaseSink *sink, gboolean *live, gboolean *upstream_live,
232 GstClockTime *min_latency, GstClockTime *max_latency);
233 GstClockTime gst_base_sink_get_latency (GstBaseSink *sink);
236 void gst_base_sink_set_render_delay (GstBaseSink *sink, GstClockTime delay);
237 GstClockTime gst_base_sink_get_render_delay (GstBaseSink *sink);
240 void gst_base_sink_set_blocksize (GstBaseSink *sink, guint blocksize);
241 guint gst_base_sink_get_blocksize (GstBaseSink *sink);
244 void gst_base_sink_set_throttle_time (GstBaseSink *sink, guint64 throttle);
245 guint64 gst_base_sink_get_throttle_time (GstBaseSink *sink);
247 GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time,
248 GstClockTimeDiff * jitter);
249 GstFlowReturn gst_base_sink_wait_eos (GstBaseSink *sink, GstClockTime time,
250 GstClockTimeDiff *jitter);
254 #endif /* __GST_BASE_SINK_H__ */