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/gstprobe.h>
34 #include <gst/gstquery.h>
35 #include <gst/gstqueryutils.h>
36 #include <gst/gsttask.h>
41 GST_EXPORT GType _gst_pad_type;
46 #define GST_TYPE_PAD (_gst_pad_type)
47 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
48 #define GST_IS_PAD_FAST(obj) (G_OBJECT_TYPE(obj) == GST_TYPE_PAD) /* necessary? */
49 #define GST_IS_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
50 #define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
51 #define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
52 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
55 /* why are these in gsttypes, again? */
56 /*typedef struct _GstPad GstPad;*/
57 /*typedef struct _GstPadClass GstPadClass;*/
58 /*typedef struct _GstPadTemplate GstPadTemplate;*/
59 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
60 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
63 GST_PAD_LINK_NOSCHED = -5, /* pads cannot cooperate in scheduling */
64 GST_PAD_LINK_NOFORMAT = -4, /* pads do not have common format */
65 GST_PAD_LINK_REFUSED = -3, /* refused for some reason */
66 GST_PAD_LINK_WRONG_DIRECTION = -2, /* pads have wrong direction */
67 GST_PAD_LINK_WAS_LINKED = -1, /* pad was already linked */
68 GST_PAD_LINK_OK = 0, /* link ok */
71 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
72 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
75 GST_FLOW_OK = 0, /* data passing was ok */
76 GST_FLOW_RESEND = 1, /* resend buffer, possibly with new caps */
77 GST_FLOW_ERROR = -1, /* some (fatal) error occured */
78 GST_FLOW_NOT_CONNECTED = -2, /* pad is not connected */
79 GST_FLOW_NOT_NEGOTIATED = -3, /* pad is not negotiated */
80 GST_FLOW_WRONG_STATE = -4, /* pad is in wrong state */
81 GST_FLOW_UNEXPECTED = -5, /* did not expect anything, this is not fatal */
82 GST_FLOW_NOT_SUPPORTED = -6 /* function not supported */
91 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
94 typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstActivateMode mode);
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, loop function is internal */
103 typedef gboolean (*GstPadCheckGetRangeFunction) (GstPad *pad);
104 typedef void (*GstPadLoopFunction) (GstPad *pad);
107 typedef GList* (*GstPadIntLinkFunction) (GstPad *pad);
109 /* generic query function */
110 typedef const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
111 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstQuery *query);
114 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
115 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
118 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad);
119 typedef gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
120 typedef gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
121 typedef GstCaps* (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
122 typedef GstFlowReturn (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset, guint size,
123 GstCaps *caps, GstBuffer **buf);
125 typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
127 typedef void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
136 GST_PAD_BLOCKED = GST_OBJECT_FLAG_LAST,
141 GST_PAD_FLAG_LAST = GST_OBJECT_FLAG_LAST + 8
147 gpointer element_private;
149 GstPadTemplate *padtemplate;
151 /* direction cannot change after creating the pad */
152 GstPadDirection direction;
154 /*< public >*/ /* with STREAM_LOCK */
155 /* streaming rec_lock */
156 GStaticRecMutex *stream_rec_lock;
158 /*< public >*/ /* with PREROLL_LOCK */
159 GMutex *preroll_lock;
162 /*< public >*/ /* with LOCK */
163 /* block cond, mutex is from the object */
165 GstPadBlockCallback block_callback;
168 /* the pad capabilities */
170 GstPadGetCapsFunction getcapsfunc;
171 GstPadSetCapsFunction setcapsfunc;
172 GstPadAcceptCapsFunction acceptcapsfunc;
173 GstPadFixateCapsFunction fixatecapsfunc;
175 GstPadActivateFunction activatefunc;
178 GstPadLinkFunction linkfunc;
179 GstPadUnlinkFunction unlinkfunc;
182 gpointer sched_private;
184 /* data transport functions */
185 GstPadLoopFunction loopfunc;
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 GstProbeDispatcher probedisp;
205 gpointer _gst_reserved[GST_PADDING];
208 struct _GstPadClass {
209 GstObjectClass parent_class;
211 /* signal callbacks */
212 void (*linked) (GstPad *pad, GstPad *peer);
213 void (*unlinked) (GstPad *pad, GstPad *peer);
214 void (*request_link) (GstPad *pad);
217 gpointer _gst_reserved[GST_PADDING];
221 /***** helper macros *****/
223 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
224 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
225 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
226 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
227 #define GST_PAD_DIRECTION(pad) (GST_PAD_CAST(pad)->direction)
228 #define GST_PAD_TASK(pad) (GST_PAD_CAST(pad)->task)
229 #define GST_PAD_ACTIVATE_MODE(pad) (GST_PAD_CAST(pad)->mode)
231 #define GST_PAD_ACTIVATEFUNC(pad) (GST_PAD_CAST(pad)->activatefunc)
232 #define GST_PAD_LOOPFUNC(pad) (GST_PAD_CAST(pad)->loopfunc)
233 #define GST_PAD_CHAINFUNC(pad) (GST_PAD_CAST(pad)->chainfunc)
234 #define GST_PAD_CHECKGETRANGEFUNC(pad) (GST_PAD_CAST(pad)->checkgetrangefunc)
235 #define GST_PAD_GETRANGEFUNC(pad) (GST_PAD_CAST(pad)->getrangefunc)
236 #define GST_PAD_EVENTFUNC(pad) (GST_PAD_CAST(pad)->eventfunc)
237 #define GST_PAD_QUERYTYPEFUNC(pad) (GST_PAD_CAST(pad)->querytypefunc)
238 #define GST_PAD_QUERYFUNC(pad) (GST_PAD_CAST(pad)->queryfunc)
239 #define GST_PAD_INTLINKFUNC(pad) (GST_PAD_CAST(pad)->intlinkfunc)
241 #define GST_PAD_PEER(pad) (GST_PAD_CAST(pad)->peer)
242 #define GST_PAD_LINKFUNC(pad) (GST_PAD_CAST(pad)->linkfunc)
243 #define GST_PAD_UNLINKFUNC(pad) (GST_PAD_CAST(pad)->unlinkfunc)
245 #define GST_PAD_CAPS(pad) (GST_PAD_CAST(pad)->caps)
246 #define GST_PAD_GETCAPSFUNC(pad) (GST_PAD_CAST(pad)->getcapsfunc)
247 #define GST_PAD_SETCAPSFUNC(pad) (GST_PAD_CAST(pad)->setcapsfunc)
248 #define GST_PAD_ACCEPTCAPSFUNC(pad) (GST_PAD_CAST(pad)->acceptcapsfunc)
249 #define GST_PAD_FIXATECAPSFUNC(pad) (GST_PAD_CAST(pad)->fixatecapsfunc)
251 #define GST_PAD_BUFFERALLOCFUNC(pad) (GST_PAD_CAST(pad)->bufferallocfunc)
253 #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
254 #define GST_PAD_IS_BLOCKED(pad) (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
255 #define GST_PAD_IS_FLUSHING(pad) (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
256 #define GST_PAD_IS_IN_GETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
257 #define GST_PAD_IS_IN_SETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
258 #define GST_PAD_IS_USABLE(pad) (GST_PAD_IS_LINKED (pad) && \
259 !GST_PAD_IS_FLUSHING(pad) && !GST_PAD_IS_FLUSHING(GST_PAD_PEER (pad)))
260 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
261 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
263 #define GST_PAD_SET_FLUSHING(pad) (GST_FLAG_SET (pad, GST_PAD_FLUSHING))
264 #define GST_PAD_UNSET_FLUSHING(pad) (GST_FLAG_UNSET (pad, GST_PAD_FLUSHING))
266 #define GST_STREAM_GET_LOCK(pad) (GST_PAD_CAST(pad)->stream_rec_lock)
267 #define GST_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
268 #define GST_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
269 #define GST_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
271 #define GST_PREROLL_GET_LOCK(pad) (GST_PAD_CAST(pad)->preroll_lock)
272 #define GST_PREROLL_LOCK(pad) (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
273 #define GST_PREROLL_TRYLOCK(pad) (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
274 #define GST_PREROLL_UNLOCK(pad) (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
275 #define GST_PREROLL_GET_COND(pad) (GST_PAD_CAST(pad)->preroll_cond)
276 #define GST_PREROLL_WAIT(pad) g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
277 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
279 #define GST_PREROLL_SIGNAL(pad) g_cond_signal (GST_PREROLL_GET_COND (pad));
280 #define GST_PREROLL_BROADCAST(pad) g_cond_broadcast (GST_PREROLL_GET_COND (pad));
282 #define GST_PAD_BLOCK_GET_COND(pad) (GST_PAD_CAST(pad)->block_cond)
283 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
284 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
286 /***** PadTemplate *****/
287 #define GST_TYPE_PAD_TEMPLATE (gst_pad_template_get_type ())
288 #define GST_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
289 #define GST_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
290 #define GST_IS_PAD_TEMPLATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
291 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
299 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ) (((GstPadTemplate *)(templ))->name_template)
300 #define GST_PAD_TEMPLATE_DIRECTION(templ) (((GstPadTemplate *)(templ))->direction)
301 #define GST_PAD_TEMPLATE_PRESENCE(templ) (((GstPadTemplate *)(templ))->presence)
302 #define GST_PAD_TEMPLATE_CAPS(templ) (((GstPadTemplate *)(templ))->caps)
305 GST_PAD_TEMPLATE_FIXED = GST_OBJECT_FLAG_LAST,
307 GST_PAD_TEMPLATE_FLAG_LAST = GST_OBJECT_FLAG_LAST + 4
308 } GstPadTemplateFlags;
310 #define GST_PAD_TEMPLATE_IS_FIXED(templ) (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
312 struct _GstPadTemplate {
315 gchar *name_template;
316 GstPadDirection direction;
317 GstPadPresence presence;
320 gpointer _gst_reserved[GST_PADDING];
323 struct _GstPadTemplateClass {
324 GstObjectClass parent_class;
326 /* signal callbacks */
327 void (*pad_created) (GstPadTemplate *templ, GstPad *pad);
329 gpointer _gst_reserved[GST_PADDING];
332 struct _GstStaticPadTemplate {
333 gchar *name_template;
334 GstPadDirection direction;
335 GstPadPresence presence;
336 GstStaticCaps static_caps;
339 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
341 /* name_template */ padname, \
342 /* direction */ dir, \
343 /* presence */ pres, \
348 GType gst_pad_get_type (void);
351 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
352 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
354 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
355 GstElement* gst_pad_get_parent (GstPad *pad);
357 GstPadDirection gst_pad_get_direction (GstPad *pad);
359 gboolean gst_pad_set_active (GstPad *pad, GstActivateMode mode);
360 gboolean gst_pad_peer_set_active (GstPad *pad, GstActivateMode mode);
361 gboolean gst_pad_is_active (GstPad *pad);
362 gboolean gst_pad_set_blocked (GstPad *pad, gboolean blocked);
363 gboolean gst_pad_set_blocked_async (GstPad *pad, gboolean blocked,
364 GstPadBlockCallback callback, gpointer user_data);
365 gboolean gst_pad_is_blocked (GstPad *pad);
367 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
368 gpointer gst_pad_get_element_private (GstPad *pad);
370 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
372 void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufalloc);
373 GstFlowReturn gst_pad_alloc_buffer (GstPad *pad, guint64 offset, gint size,
374 GstCaps *caps, GstBuffer **buf);
376 /* data passing setup functions */
377 void gst_pad_set_activate_function (GstPad *pad, GstPadActivateFunction activate);
378 void gst_pad_set_loop_function (GstPad *pad, GstPadLoopFunction loop);
379 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
380 void gst_pad_set_getrange_function (GstPad *pad, GstPadGetRangeFunction get);
381 void gst_pad_set_checkgetrange_function (GstPad *pad, GstPadCheckGetRangeFunction check);
382 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
385 void gst_pad_set_link_function (GstPad *pad, GstPadLinkFunction link);
386 void gst_pad_set_unlink_function (GstPad *pad, GstPadUnlinkFunction unlink);
388 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
389 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
390 gboolean gst_pad_is_linked (GstPad *pad);
392 GstPad* gst_pad_get_peer (GstPad *pad);
394 /* capsnego functions */
395 void gst_pad_set_getcaps_function (GstPad *pad, GstPadGetCapsFunction getcaps);
396 void gst_pad_set_acceptcaps_function (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
397 void gst_pad_set_fixatecaps_function (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
398 void gst_pad_set_setcaps_function (GstPad *pad, GstPadSetCapsFunction setcaps);
400 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
402 /* capsnego function for connected/unconnected pads */
403 GstCaps * gst_pad_get_caps (GstPad * pad);
404 GstCaps* gst_pad_fixate_caps (GstPad * pad, GstCaps *caps);
405 gboolean gst_pad_accept_caps (GstPad * pad, GstCaps *caps);
406 gboolean gst_pad_set_caps (GstPad * pad, GstCaps *caps);
408 GstCaps * gst_pad_peer_get_caps (GstPad * pad);
409 gboolean gst_pad_peer_accept_caps (GstPad * pad, GstCaps *caps);
411 /* capsnego for connected pads */
412 GstCaps * gst_pad_get_allowed_caps (GstPad * srcpad);
413 GstCaps * gst_pad_get_negotiated_caps (GstPad * pad);
415 /* data passing functions to peer */
416 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
417 gboolean gst_pad_check_pull_range (GstPad *pad);
418 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
420 gboolean gst_pad_push_event (GstPad *pad, GstEvent *event);
421 gboolean gst_pad_event_default (GstPad *pad, GstEvent *event);
423 /* data passing functions on pad */
424 GstFlowReturn gst_pad_chain (GstPad *pad, GstBuffer *buffer);
425 GstFlowReturn gst_pad_get_range (GstPad *pad, guint64 offset, guint size,
427 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
430 gboolean gst_pad_start_task (GstPad *pad, GstTaskFunction func,
432 gboolean gst_pad_pause_task (GstPad *pad);
433 gboolean gst_pad_stop_task (GstPad *pad);
436 void gst_pad_set_internal_link_function (GstPad *pad, GstPadIntLinkFunction intlink);
437 GList* gst_pad_get_internal_links (GstPad *pad);
438 GList* gst_pad_get_internal_links_default (GstPad *pad);
440 /* generic query function */
441 void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func);
442 G_CONST_RETURN GstQueryType*
443 gst_pad_get_query_types (GstPad *pad);
444 G_CONST_RETURN GstQueryType*
445 gst_pad_get_query_types_default (GstPad *pad);
447 gboolean gst_pad_query (GstPad *pad, GstQuery *query);
448 void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
449 gboolean gst_pad_query_default (GstPad *pad, GstQuery *query);
451 /* misc helper functions */
452 gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch,
455 #define gst_pad_add_probe(pad, probe) \
456 (gst_probe_dispatcher_add_probe (&(GST_PAD_CAST (pad)->probedisp), probe))
457 #define gst_pad_remove_probe(pad, probe) \
458 (gst_probe_dispatcher_remove_probe (&(GST_PAD_CAST (pad)->probedisp), probe))
460 #ifndef GST_DISABLE_LOADSAVE
461 void gst_pad_load_and_link (xmlNodePtr self, GstObject *parent);
465 /* templates and factories */
466 GType gst_pad_template_get_type (void);
468 GstPadTemplate* gst_pad_template_new (const gchar *name_template,
469 GstPadDirection direction, GstPadPresence presence,
472 GstPadTemplate * gst_static_pad_template_get (GstStaticPadTemplate *pad_template);
473 GstCaps* gst_static_pad_template_get_caps (GstStaticPadTemplate *templ);
474 GstCaps* gst_pad_template_get_caps (GstPadTemplate *templ);
479 #endif /* __GST_PAD_H__ */