2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstpad.h: Header for GstPad object
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.
27 #include <gst/gstconfig.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstbuffer.h>
31 #include <gst/gstcaps.h>
32 #include <gst/gstevent.h>
33 #include <gst/gstquery.h>
34 #include <gst/gstqueryutils.h>
35 #include <gst/gsttask.h>
40 GST_EXPORT GType _gst_pad_type;
45 #define GST_TYPE_PAD (_gst_pad_type)
46 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
47 #define GST_IS_PAD_FAST(obj) (G_OBJECT_TYPE(obj) == GST_TYPE_PAD) /* necessary? */
48 #define GST_IS_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
49 #define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
50 #define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
51 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
54 /* why are these in gsttypes, again? */
55 /*typedef struct _GstPad GstPad;*/
56 /*typedef struct _GstPadClass GstPadClass;*/
57 /*typedef struct _GstPadTemplate GstPadTemplate;*/
58 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
59 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
62 GST_PAD_LINK_NOSCHED = -5, /* pads cannot cooperate in scheduling */
63 GST_PAD_LINK_NOFORMAT = -4, /* pads do not have common format */
64 GST_PAD_LINK_REFUSED = -3, /* refused for some reason */
65 GST_PAD_LINK_WRONG_DIRECTION = -2, /* pads have wrong direction */
66 GST_PAD_LINK_WAS_LINKED = -1, /* pad was already linked */
67 GST_PAD_LINK_OK = 0, /* link ok */
70 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
71 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
74 GST_FLOW_OK = 0, /* data passing was ok */
75 GST_FLOW_RESEND = 1, /* resend buffer, possibly with new caps */
76 GST_FLOW_ERROR = -1, /* some (fatal) error occured */
77 GST_FLOW_NOT_LINKED = -2, /* pad is not linked */
78 GST_FLOW_NOT_NEGOTIATED = -3, /* pad is not negotiated */
79 GST_FLOW_WRONG_STATE = -4, /* pad is in wrong state */
80 GST_FLOW_UNEXPECTED = -5, /* did not expect anything, this is not fatal */
81 GST_FLOW_NOT_SUPPORTED = -6 /* function not supported */
90 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
93 typedef gboolean (*GstPadActivateFunction) (GstPad *pad);
94 typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, gboolean active);
97 typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstBuffer *buffer);
98 typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset,
99 guint length, GstBuffer **buffer);
100 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
102 /* deprecate me, check range should use seeking query */
103 typedef gboolean (*GstPadCheckGetRangeFunction) (GstPad *pad);
106 typedef GList* (*GstPadIntLinkFunction) (GstPad *pad);
108 /* generic query function */
109 typedef const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
110 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstQuery *query);
113 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
114 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
117 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad);
118 typedef gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
119 typedef gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
120 typedef GstCaps* (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
121 typedef GstFlowReturn (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset, guint size,
122 GstCaps *caps, GstBuffer **buf);
124 typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
126 typedef void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
135 GST_PAD_BLOCKED = GST_OBJECT_FLAG_LAST,
140 GST_PAD_FLAG_LAST = GST_OBJECT_FLAG_LAST + 8
146 gpointer element_private;
148 GstPadTemplate *padtemplate;
150 /* direction cannot change after creating the pad */
151 GstPadDirection direction;
153 /*< public >*/ /* with STREAM_LOCK */
154 /* streaming rec_lock */
155 GStaticRecMutex *stream_rec_lock;
157 /*< public >*/ /* with PREROLL_LOCK */
158 GMutex *preroll_lock;
161 /*< public >*/ /* with LOCK */
162 /* block cond, mutex is from the object */
164 GstPadBlockCallback block_callback;
167 /* the pad capabilities */
169 GstPadGetCapsFunction getcapsfunc;
170 GstPadSetCapsFunction setcapsfunc;
171 GstPadAcceptCapsFunction acceptcapsfunc;
172 GstPadFixateCapsFunction fixatecapsfunc;
174 GstPadActivateFunction activatefunc;
175 GstPadActivateModeFunction activatepushfunc;
176 GstPadActivateModeFunction activatepullfunc;
179 GstPadLinkFunction linkfunc;
180 GstPadUnlinkFunction unlinkfunc;
183 gpointer sched_private;
185 /* data transport functions */
186 GstPadChainFunction chainfunc;
187 GstPadCheckGetRangeFunction checkgetrangefunc;
188 GstPadGetRangeFunction getrangefunc;
189 GstPadEventFunction eventfunc;
191 GstActivateMode mode;
193 /* generic query method */
194 GstPadQueryTypeFunction querytypefunc;
195 GstPadQueryFunction queryfunc;
198 GstPadIntLinkFunction intlinkfunc;
200 GstPadBufferAllocFunction bufferallocfunc;
202 /* whether to emit signals for have-data */
203 gint emit_buffer_signals, emit_event_signals;
206 gpointer _gst_reserved[GST_PADDING];
209 struct _GstPadClass {
210 GstObjectClass parent_class;
212 /* signal callbacks */
213 void (*linked) (GstPad *pad, GstPad *peer);
214 void (*unlinked) (GstPad *pad, GstPad *peer);
215 void (*request_link) (GstPad *pad);
216 gboolean (*have_data) (GstPad *pad, GstMiniObject *data);
219 gpointer _gst_reserved[GST_PADDING];
223 /***** helper macros *****/
225 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
226 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
227 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
228 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
229 #define GST_PAD_DIRECTION(pad) (GST_PAD_CAST(pad)->direction)
230 #define GST_PAD_TASK(pad) (GST_PAD_CAST(pad)->task)
231 #define GST_PAD_ACTIVATE_MODE(pad) (GST_PAD_CAST(pad)->mode)
233 #define GST_PAD_ACTIVATEFUNC(pad) (GST_PAD_CAST(pad)->activatefunc)
234 #define GST_PAD_ACTIVATEPUSHFUNC(pad) (GST_PAD_CAST(pad)->activatepushfunc)
235 #define GST_PAD_ACTIVATEPULLFUNC(pad) (GST_PAD_CAST(pad)->activatepullfunc)
236 #define GST_PAD_CHAINFUNC(pad) (GST_PAD_CAST(pad)->chainfunc)
237 #define GST_PAD_CHECKGETRANGEFUNC(pad) (GST_PAD_CAST(pad)->checkgetrangefunc)
238 #define GST_PAD_GETRANGEFUNC(pad) (GST_PAD_CAST(pad)->getrangefunc)
239 #define GST_PAD_EVENTFUNC(pad) (GST_PAD_CAST(pad)->eventfunc)
240 #define GST_PAD_QUERYTYPEFUNC(pad) (GST_PAD_CAST(pad)->querytypefunc)
241 #define GST_PAD_QUERYFUNC(pad) (GST_PAD_CAST(pad)->queryfunc)
242 #define GST_PAD_INTLINKFUNC(pad) (GST_PAD_CAST(pad)->intlinkfunc)
244 #define GST_PAD_PEER(pad) (GST_PAD_CAST(pad)->peer)
245 #define GST_PAD_LINKFUNC(pad) (GST_PAD_CAST(pad)->linkfunc)
246 #define GST_PAD_UNLINKFUNC(pad) (GST_PAD_CAST(pad)->unlinkfunc)
248 #define GST_PAD_CAPS(pad) (GST_PAD_CAST(pad)->caps)
249 #define GST_PAD_GETCAPSFUNC(pad) (GST_PAD_CAST(pad)->getcapsfunc)
250 #define GST_PAD_SETCAPSFUNC(pad) (GST_PAD_CAST(pad)->setcapsfunc)
251 #define GST_PAD_ACCEPTCAPSFUNC(pad) (GST_PAD_CAST(pad)->acceptcapsfunc)
252 #define GST_PAD_FIXATECAPSFUNC(pad) (GST_PAD_CAST(pad)->fixatecapsfunc)
254 #define GST_PAD_BUFFERALLOCFUNC(pad) (GST_PAD_CAST(pad)->bufferallocfunc)
256 #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
257 #define GST_PAD_IS_BLOCKED(pad) (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
258 #define GST_PAD_IS_FLUSHING(pad) (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
259 #define GST_PAD_IS_IN_GETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
260 #define GST_PAD_IS_IN_SETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
261 #define GST_PAD_IS_USABLE(pad) (GST_PAD_IS_LINKED (pad) && \
262 !GST_PAD_IS_FLUSHING(pad) && !GST_PAD_IS_FLUSHING(GST_PAD_PEER (pad)))
263 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
264 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
266 #define GST_PAD_SET_FLUSHING(pad) (GST_FLAG_SET (pad, GST_PAD_FLUSHING))
267 #define GST_PAD_UNSET_FLUSHING(pad) (GST_FLAG_UNSET (pad, GST_PAD_FLUSHING))
269 #define GST_STREAM_GET_LOCK(pad) (GST_PAD_CAST(pad)->stream_rec_lock)
270 #define GST_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
271 #define GST_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
272 #define GST_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
273 #define GST_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_STREAM_GET_LOCK(pad)))
274 #define GST_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_STREAM_GET_LOCK(pad), t))
276 #define GST_PREROLL_GET_LOCK(pad) (GST_PAD_CAST(pad)->preroll_lock)
277 #define GST_PREROLL_LOCK(pad) (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
278 #define GST_PREROLL_TRYLOCK(pad) (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
279 #define GST_PREROLL_UNLOCK(pad) (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
280 #define GST_PREROLL_GET_COND(pad) (GST_PAD_CAST(pad)->preroll_cond)
281 #define GST_PREROLL_WAIT(pad) g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
282 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
284 #define GST_PREROLL_SIGNAL(pad) g_cond_signal (GST_PREROLL_GET_COND (pad));
285 #define GST_PREROLL_BROADCAST(pad) g_cond_broadcast (GST_PREROLL_GET_COND (pad));
287 #define GST_PAD_BLOCK_GET_COND(pad) (GST_PAD_CAST(pad)->block_cond)
288 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
289 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
291 /***** PadTemplate *****/
292 #define GST_TYPE_PAD_TEMPLATE (gst_pad_template_get_type ())
293 #define GST_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
294 #define GST_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
295 #define GST_IS_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
296 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
304 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ) (((GstPadTemplate *)(templ))->name_template)
305 #define GST_PAD_TEMPLATE_DIRECTION(templ) (((GstPadTemplate *)(templ))->direction)
306 #define GST_PAD_TEMPLATE_PRESENCE(templ) (((GstPadTemplate *)(templ))->presence)
307 #define GST_PAD_TEMPLATE_CAPS(templ) (((GstPadTemplate *)(templ))->caps)
310 GST_PAD_TEMPLATE_FIXED = GST_OBJECT_FLAG_LAST,
312 GST_PAD_TEMPLATE_FLAG_LAST = GST_OBJECT_FLAG_LAST + 4
313 } GstPadTemplateFlags;
315 #define GST_PAD_TEMPLATE_IS_FIXED(templ) (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
317 struct _GstPadTemplate {
320 gchar *name_template;
321 GstPadDirection direction;
322 GstPadPresence presence;
325 gpointer _gst_reserved[GST_PADDING];
328 struct _GstPadTemplateClass {
329 GstObjectClass parent_class;
331 /* signal callbacks */
332 void (*pad_created) (GstPadTemplate *templ, GstPad *pad);
334 gpointer _gst_reserved[GST_PADDING];
337 struct _GstStaticPadTemplate {
338 gchar *name_template;
339 GstPadDirection direction;
340 GstPadPresence presence;
341 GstStaticCaps static_caps;
344 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
346 /* name_template */ padname, \
347 /* direction */ dir, \
348 /* presence */ pres, \
353 GType gst_pad_get_type (void);
356 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
357 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
359 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
360 GstElement* gst_pad_get_parent (GstPad *pad);
362 GstPadDirection gst_pad_get_direction (GstPad *pad);
364 gboolean gst_pad_set_active (GstPad *pad, gboolean active);
365 gboolean gst_pad_is_active (GstPad *pad);
366 gboolean gst_pad_activate_pull (GstPad *pad, gboolean active);
367 gboolean gst_pad_activate_push (GstPad *pad, gboolean active);
369 gboolean gst_pad_set_blocked (GstPad *pad, gboolean blocked);
370 gboolean gst_pad_set_blocked_async (GstPad *pad, gboolean blocked,
371 GstPadBlockCallback callback, gpointer user_data);
372 gboolean gst_pad_is_blocked (GstPad *pad);
374 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
375 gpointer gst_pad_get_element_private (GstPad *pad);
377 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
379 void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufalloc);
380 GstFlowReturn gst_pad_alloc_buffer (GstPad *pad, guint64 offset, gint size,
381 GstCaps *caps, GstBuffer **buf);
383 /* data passing setup functions */
384 void gst_pad_set_activate_function (GstPad *pad, GstPadActivateFunction activate);
385 void gst_pad_set_activatepull_function (GstPad *pad, GstPadActivateModeFunction activatepull);
386 void gst_pad_set_activatepush_function (GstPad *pad, GstPadActivateModeFunction activatepush);
387 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
388 void gst_pad_set_getrange_function (GstPad *pad, GstPadGetRangeFunction get);
389 void gst_pad_set_checkgetrange_function (GstPad *pad, GstPadCheckGetRangeFunction check);
390 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
393 void gst_pad_set_link_function (GstPad *pad, GstPadLinkFunction link);
394 void gst_pad_set_unlink_function (GstPad *pad, GstPadUnlinkFunction unlink);
396 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
397 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
398 gboolean gst_pad_is_linked (GstPad *pad);
400 GstPad* gst_pad_get_peer (GstPad *pad);
402 /* capsnego functions */
403 void gst_pad_set_getcaps_function (GstPad *pad, GstPadGetCapsFunction getcaps);
404 void gst_pad_set_acceptcaps_function (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
405 void gst_pad_set_fixatecaps_function (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
406 void gst_pad_set_setcaps_function (GstPad *pad, GstPadSetCapsFunction setcaps);
408 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
410 /* capsnego function for connected/unconnected pads */
411 GstCaps * gst_pad_get_caps (GstPad * pad);
412 GstCaps* gst_pad_fixate_caps (GstPad * pad, GstCaps *caps);
413 gboolean gst_pad_accept_caps (GstPad * pad, GstCaps *caps);
414 gboolean gst_pad_set_caps (GstPad * pad, GstCaps *caps);
416 GstCaps * gst_pad_peer_get_caps (GstPad * pad);
417 gboolean gst_pad_peer_accept_caps (GstPad * pad, GstCaps *caps);
419 /* capsnego for connected pads */
420 GstCaps * gst_pad_get_allowed_caps (GstPad * srcpad);
421 GstCaps * gst_pad_get_negotiated_caps (GstPad * pad);
423 /* data passing functions to peer */
424 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
425 gboolean gst_pad_check_pull_range (GstPad *pad);
426 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
428 gboolean gst_pad_push_event (GstPad *pad, GstEvent *event);
429 gboolean gst_pad_event_default (GstPad *pad, GstEvent *event);
431 /* data passing functions on pad */
432 GstFlowReturn gst_pad_chain (GstPad *pad, GstBuffer *buffer);
433 GstFlowReturn gst_pad_get_range (GstPad *pad, guint64 offset, guint size,
435 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
438 gboolean gst_pad_start_task (GstPad *pad, GstTaskFunction func,
440 gboolean gst_pad_pause_task (GstPad *pad);
441 gboolean gst_pad_stop_task (GstPad *pad);
444 void gst_pad_set_internal_link_function (GstPad *pad, GstPadIntLinkFunction intlink);
445 GList* gst_pad_get_internal_links (GstPad *pad);
446 GList* gst_pad_get_internal_links_default (GstPad *pad);
448 /* generic query function */
449 void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func);
450 G_CONST_RETURN GstQueryType*
451 gst_pad_get_query_types (GstPad *pad);
452 G_CONST_RETURN GstQueryType*
453 gst_pad_get_query_types_default (GstPad *pad);
455 gboolean gst_pad_query (GstPad *pad, GstQuery *query);
456 void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
457 gboolean gst_pad_query_default (GstPad *pad, GstQuery *query);
459 /* misc helper functions */
460 gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch,
463 #ifndef GST_DISABLE_LOADSAVE
464 void gst_pad_load_and_link (xmlNodePtr self, GstObject *parent);
468 /* templates and factories */
469 GType gst_pad_template_get_type (void);
471 GstPadTemplate* gst_pad_template_new (const gchar *name_template,
472 GstPadDirection direction, GstPadPresence presence,
475 GstPadTemplate * gst_static_pad_template_get (GstStaticPadTemplate *pad_template);
476 GstCaps* gst_static_pad_template_get_caps (GstStaticPadTemplate *templ);
477 GstCaps* gst_pad_template_get_caps (GstPadTemplate *templ);
482 #endif /* __GST_PAD_H__ */