2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2005 Wim Taymans <wim@fluendo.com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #ifndef __GST_BASE_TRANSFORM_H__
22 #define __GST_BASE_TRANSFORM_H__
28 #define GST_TYPE_BASE_TRANSFORM (gst_base_transform_get_type())
29 #define GST_BASE_TRANSFORM(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransform))
30 #define GST_BASE_TRANSFORM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
31 #define GST_BASE_TRANSFORM_GET_CLASS(obj) \
32 (G_TYPE_INSTANCE_GET_CLASS ((obj),GST_TYPE_BASE_TRANSFORM,GstBaseTransformClass))
33 #define GST_IS_BASE_TRANSFORM(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_BASE_TRANSFORM))
34 #define GST_IS_BASE_TRANSFORM_CLASS(obj)(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_BASE_TRANSFORM))
37 * GST_BASE_TRANSFORM_SINK_NAME:
39 * the name of the templates for the sink pad
41 #define GST_BASE_TRANSFORM_SINK_NAME "sink"
43 * GST_BASE_TRANSFORM_SRC_NAME:
45 * the name of the templates for the source pad
47 #define GST_BASE_TRANSFORM_SRC_NAME "src"
49 typedef struct _GstBaseTransform GstBaseTransform;
50 typedef struct _GstBaseTransformClass GstBaseTransformClass;
52 struct _GstBaseTransform {
55 /* source and sink pads */
60 /* Set by sub-class */
62 gboolean always_in_place;
65 guint cache_caps1_size;
67 guint cache_caps2_size;
69 gboolean delay_configure;
70 gboolean pending_configure;
73 gboolean have_newsegment;
75 /* MT-protected (with STREAM_LOCK) */
81 /* FIXME: When adjusting the padding, move this to a nice place in the structure */
82 /* Set if caps on each pad are equal */
83 gboolean have_same_caps;
86 gpointer _gst_reserved[GST_PADDING - 1];
90 * GstBaseTransformClass::transform_caps:
91 * @direction: the pad direction
94 * This method should answer the question "given this pad, and given these
95 * caps, what caps would you allow on the other pad inside your element ?"
97 struct _GstBaseTransformClass {
98 GstElementClass parent_class;
101 /* virtual methods for subclasses */
103 /* given the (non-)fixed simple caps on the pad in the given direction,
104 * what can I do on the other pad ? */
105 GstCaps* (*transform_caps) (GstBaseTransform *trans,
106 GstPadDirection direction,
109 /* given caps on one pad, how would you fixate caps on the other pad ? */
110 void (*fixate_caps) (GstBaseTransform *trans,
111 GstPadDirection direction, GstCaps *caps,
114 /* given the size of a buffer in the given direction with the given caps,
115 * calculate the byte size of an buffer on the other side with the given
116 * other caps; the default
117 * implementation uses get_size and keeps the number of units the same */
118 gboolean (*transform_size) (GstBaseTransform *trans,
119 GstPadDirection direction,
120 GstCaps *caps, guint size,
121 GstCaps *othercaps, guint *othersize);
123 /* get the byte size of one unit for a given caps.
124 * Always needs to be implemented if the transform is not in-place. */
125 gboolean (*get_unit_size) (GstBaseTransform *trans, GstCaps *caps,
128 /* notify the subclass of new caps */
129 gboolean (*set_caps) (GstBaseTransform *trans, GstCaps *incaps,
132 /* start and stop processing, ideal for opening/closing the resource */
133 gboolean (*start) (GstBaseTransform *trans);
134 gboolean (*stop) (GstBaseTransform *trans);
136 gboolean (*event) (GstBaseTransform *trans, GstEvent *event);
138 /* transform one incoming buffer to one outgoing buffer.
139 * Always needs to be implemented unless always operating in-place.
140 * transform function is allowed to change size/timestamp/duration of
141 * the outgoing buffer. */
142 GstFlowReturn (*transform) (GstBaseTransform *trans, GstBuffer *inbuf,
145 /* transform a buffer inplace */
146 GstFlowReturn (*transform_ip) (GstBaseTransform *trans, GstBuffer *buf);
148 /* FIXME: When adjusting the padding, more these to nicer places in the class */
149 /* Set by child classes to automatically do passthrough mode */
150 gboolean passthrough_on_same_caps;
152 /* Subclasses can override this to do their own allocation of output buffers.
153 * Elements that only do analysis can return a subbuffer or even just
154 * increment the reference to the input buffer (if in passthrough mode)
156 GstFlowReturn (*prepare_output_buffer) (GstBaseTransform * trans,
157 GstBuffer *input, gint size, GstCaps *caps, GstBuffer **buf);
160 gpointer _gst_reserved[GST_PADDING - 2];
163 void gst_base_transform_set_passthrough (GstBaseTransform *trans,
164 gboolean passthrough);
165 gboolean gst_base_transform_is_passthrough (GstBaseTransform *trans);
167 void gst_base_transform_set_in_place (GstBaseTransform *trans,
169 gboolean gst_base_transform_is_in_place (GstBaseTransform *trans);
171 GType gst_base_transform_get_type (void);
175 #endif /* __GST_BASE_TRANSFORM_H__ */