Merge branch 'master' into 0.11
[platform/upstream/gstreamer.git] / gst / gstghostpad.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wim.taymans@chello.be>
4  *                    2005 Andy Wingo <wingo@pobox.com>
5  *
6  * gstghostpad.h: Proxy pads
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24
25 #ifndef __GST_GHOST_PAD_H__
26 #define __GST_GHOST_PAD_H__
27
28
29 #include <gst/gstpad.h>
30
31
32 G_BEGIN_DECLS
33
34 #define GST_TYPE_PROXY_PAD              (gst_proxy_pad_get_type ())
35 #define GST_IS_PROXY_PAD(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PROXY_PAD))
36 #define GST_IS_PROXY_PAD_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PROXY_PAD))
37 #define GST_PROXY_PAD(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PROXY_PAD, GstProxyPad))
38 #define GST_PROXY_PAD_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PROXY_PAD, GstProxyPadClass))
39
40 typedef struct _GstProxyPad GstProxyPad;
41 typedef struct _GstProxyPadPrivate GstProxyPadPrivate;
42 typedef struct _GstProxyPadClass GstProxyPadClass;
43
44 struct _GstProxyPad
45 {
46   GstPad pad;
47
48   /*< private >*/
49   GstProxyPadPrivate *priv;
50 };
51
52 struct _GstProxyPadClass
53 {
54   GstPadClass parent_class;
55
56   /*< private >*/
57   gpointer _gst_reserved[1];
58 };
59
60 GType gst_proxy_pad_get_type (void);
61
62 GstProxyPad*     gst_proxy_pad_get_internal     (GstProxyPad *pad);
63
64
65 gboolean            gst_proxy_pad_event_default                  (GstPad *pad, GstObject *parent,
66                                                                   GstEvent *event);
67 gboolean            gst_proxy_pad_query_default                  (GstPad *pad, GstObject *parent,
68                                                                   GstQuery *query);
69 GstIterator*        gst_proxy_pad_iterate_internal_links_default (GstPad *pad, GstObject *parent) G_GNUC_MALLOC;
70 GstFlowReturn       gst_proxy_pad_chain_default                  (GstPad *pad, GstObject *parent,
71                                                                   GstBuffer *buffer);
72 GstFlowReturn       gst_proxy_pad_chain_list_default             (GstPad *pad, GstObject *parent,
73                                                                   GstBufferList *list);
74 GstFlowReturn       gst_proxy_pad_getrange_default               (GstPad *pad, GstObject *parent,
75                                                                   guint64 offset, guint size,
76                                                                   GstBuffer **buffer);
77 void                gst_proxy_pad_unlink_default                 (GstPad * pad);
78
79 #define GST_TYPE_GHOST_PAD              (gst_ghost_pad_get_type ())
80 #define GST_IS_GHOST_PAD(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_GHOST_PAD))
81 #define GST_IS_GHOST_PAD_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GHOST_PAD))
82 #define GST_GHOST_PAD(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GHOST_PAD, GstGhostPad))
83 #define GST_GHOST_PAD_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GHOST_PAD, GstGhostPadClass))
84 #define GST_GHOST_PAD_CAST(obj)         ((GstGhostPad*)(obj))
85
86 /**
87  * GstGhostPad:
88  *
89  * Opaque #GstGhostPad structure.
90  */
91 typedef struct _GstGhostPad GstGhostPad;
92 typedef struct _GstGhostPadPrivate GstGhostPadPrivate;
93 typedef struct _GstGhostPadClass GstGhostPadClass;
94
95 struct _GstGhostPad
96 {
97   GstProxyPad pad;
98
99   /*< private >*/
100   GstGhostPadPrivate *priv;
101 };
102
103 struct _GstGhostPadClass
104 {
105   GstProxyPadClass parent_class;
106
107   /*< private >*/
108   gpointer _gst_reserved[GST_PADDING];
109 };
110
111
112 GType            gst_ghost_pad_get_type          (void);
113
114 GstPad*          gst_ghost_pad_new               (const gchar *name, GstPad *target) G_GNUC_MALLOC;
115 GstPad*          gst_ghost_pad_new_no_target     (const gchar *name, GstPadDirection dir) G_GNUC_MALLOC;
116
117 GstPad*          gst_ghost_pad_new_from_template (const gchar *name, GstPad * target, GstPadTemplate * templ) G_GNUC_MALLOC;
118 GstPad*          gst_ghost_pad_new_no_target_from_template (const gchar *name, GstPadTemplate * templ) G_GNUC_MALLOC;
119
120 GstPad*          gst_ghost_pad_get_target        (GstGhostPad *gpad);
121 gboolean         gst_ghost_pad_set_target        (GstGhostPad *gpad, GstPad *newtarget);
122
123 gboolean         gst_ghost_pad_construct         (GstGhostPad *gpad);
124
125 void             gst_ghost_pad_unlink_default         (GstPad * pad);
126 GstPadLinkReturn gst_ghost_pad_link_default           (GstPad * pad, GstPad * peer);
127
128 gboolean         gst_ghost_pad_activate_mode_default  (GstPad * pad, GstObject * parent,
129                                                        GstPadMode mode, gboolean active);
130
131 gboolean         gst_ghost_pad_internal_activate_mode_default   (GstPad * pad, GstObject * parent,
132                                                                  GstPadMode mode, gboolean active);
133
134 G_END_DECLS
135
136 #endif /* __GST_GHOST_PAD_H__ */