1 | /* GStreamer |
2 | * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu> |
3 | * 2000 Wim Taymans <wtay@chello.be> |
4 | * 2005 Wim Taymans <wim@fluendo.com> |
5 | * |
6 | * gstpushsrc.h: |
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., 51 Franklin St, Fifth Floor, |
21 | * Boston, MA 02110-1301, USA. |
22 | */ |
23 | |
24 | #ifndef __GST_PUSH_SRC_H__ |
25 | #define __GST_PUSH_SRC_H__ |
26 | |
27 | #include <gst/gst.h> |
28 | #include <gst/base/gstbasesrc.h> |
29 | |
30 | G_BEGIN_DECLS |
31 | |
32 | #define GST_TYPE_PUSH_SRC (gst_push_src_get_type()) |
33 | #define GST_PUSH_SRC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PUSH_SRC,GstPushSrc)) |
34 | #define GST_PUSH_SRC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PUSH_SRC,GstPushSrcClass)) |
35 | #define GST_PUSH_SRC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PUSH_SRC, GstPushSrcClass)) |
36 | #define GST_IS_PUSH_SRC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PUSH_SRC)) |
37 | #define GST_IS_PUSH_SRC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PUSH_SRC)) |
38 | |
39 | typedef struct _GstPushSrc GstPushSrc; |
40 | typedef struct _GstPushSrcClass GstPushSrcClass; |
41 | |
42 | /** |
43 | * GstPushSrc: |
44 | * |
45 | * The opaque #GstPushSrc data structure. |
46 | */ |
47 | struct _GstPushSrc { |
48 | GstBaseSrc parent; |
49 | |
50 | /*< private >*/ |
51 | gpointer _gst_reserved[GST_PADDING]; |
52 | }; |
53 | |
54 | /** |
55 | * GstPushSrcClass: |
56 | * @parent_class: Element parent class |
57 | * @create: Ask the subclass to create a buffer. The subclass decides which |
58 | * size this buffer should be. Other then that, refer to |
59 | * #GstBaseSrc<!-- -->.create() for more details. If this method is |
60 | * not implemented, @alloc followed by @fill will be called. |
61 | * @alloc: Ask the subclass to allocate a buffer. The subclass decides which |
62 | * size this buffer should be. The default implementation will create |
63 | * a new buffer from the negotiated allocator. |
64 | * @fill: Ask the subclass to fill the buffer with data. |
65 | * |
66 | * Subclasses can override any of the available virtual methods or not, as |
67 | * needed. At the minimum, the @fill method should be overridden to produce |
68 | * buffers. |
69 | */ |
70 | struct _GstPushSrcClass { |
71 | GstBaseSrcClass parent_class; |
72 | |
73 | /** |
74 | * GstPushSrcClass::create: |
75 | * @buf: (inout): |
76 | * |
77 | * Ask the subclass to create a buffer, the default implementation will call alloc if |
78 | * no allocated @buf is provided and then call fill. |
79 | */ |
80 | GstFlowReturn (*create) (GstPushSrc *src, GstBuffer **buf); |
81 | /** |
82 | * GstPushSrcClass::alloc: |
83 | * @buf: (out): |
84 | * |
85 | * Allocate memory for a buffer. |
86 | */ |
87 | GstFlowReturn (*alloc) (GstPushSrc *src, GstBuffer **buf); |
88 | /* ask the subclass to fill a buffer */ |
89 | GstFlowReturn (*fill) (GstPushSrc *src, GstBuffer *buf); |
90 | |
91 | /*< private >*/ |
92 | gpointer _gst_reserved[GST_PADDING]; |
93 | }; |
94 | |
95 | GST_BASE_API |
96 | GType gst_push_src_get_type (void); |
97 | |
98 | G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstPushSrc, gst_object_unref) |
99 | |
100 | G_END_DECLS |
101 | |
102 | #endif /* __GST_PUSH_SRC_H__ */ |
103 | |