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 * 2005 David Schleef <ds@schleef.org>
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.
23 * SECTION:element-capsfilter
25 * The element does not modify data as such, but can enforce limitations on the
29 * <title>Example launch line</title>
31 * gst-launch videotestsrc ! video/x-raw-gray ! ffmpegcolorspace ! autovideosink
32 * ]| Limits acceptable video from videotestsrc to be grayscale.
40 #include "../../gst/gst-i18n-lib.h"
41 #include "gstcapsfilter.h"
50 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
55 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
61 GST_DEBUG_CATEGORY_STATIC (gst_capsfilter_debug);
62 #define GST_CAT_DEFAULT gst_capsfilter_debug
65 GST_DEBUG_CATEGORY_INIT (gst_capsfilter_debug, "capsfilter", 0, \
66 "capsfilter element");
67 #define gst_capsfilter_parent_class parent_class
68 G_DEFINE_TYPE_WITH_CODE (GstCapsFilter, gst_capsfilter, GST_TYPE_BASE_TRANSFORM,
72 static void gst_capsfilter_set_property (GObject * object, guint prop_id,
73 const GValue * value, GParamSpec * pspec);
74 static void gst_capsfilter_get_property (GObject * object, guint prop_id,
75 GValue * value, GParamSpec * pspec);
76 static void gst_capsfilter_dispose (GObject * object);
78 static GstCaps *gst_capsfilter_transform_caps (GstBaseTransform * base,
79 GstPadDirection direction, GstCaps * caps, GstCaps * filter);
80 static gboolean gst_capsfilter_accept_caps (GstBaseTransform * base,
81 GstPadDirection direction, GstCaps * caps);
82 static GstFlowReturn gst_capsfilter_transform_ip (GstBaseTransform * base,
84 static GstFlowReturn gst_capsfilter_prepare_buf (GstBaseTransform * trans,
85 GstBuffer * input, GstBuffer ** buf);
88 gst_capsfilter_class_init (GstCapsFilterClass * klass)
90 GObjectClass *gobject_class;
91 GstElementClass *gstelement_class;
92 GstBaseTransformClass *trans_class;
94 gobject_class = G_OBJECT_CLASS (klass);
95 gobject_class->set_property = gst_capsfilter_set_property;
96 gobject_class->get_property = gst_capsfilter_get_property;
97 gobject_class->dispose = gst_capsfilter_dispose;
99 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
100 g_param_spec_boxed ("caps", _("Filter caps"),
101 _("Restrict the possible allowed capabilities (NULL means ANY). "
102 "Setting this property takes a reference to the supplied GstCaps "
103 "object."), GST_TYPE_CAPS,
104 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
106 gstelement_class = GST_ELEMENT_CLASS (klass);
107 gst_element_class_set_details_simple (gstelement_class,
110 "Pass data without modification, limiting formats",
111 "David Schleef <ds@schleef.org>");
112 gst_element_class_add_pad_template (gstelement_class,
113 gst_static_pad_template_get (&srctemplate));
114 gst_element_class_add_pad_template (gstelement_class,
115 gst_static_pad_template_get (&sinktemplate));
117 trans_class = GST_BASE_TRANSFORM_CLASS (klass);
118 trans_class->transform_caps =
119 GST_DEBUG_FUNCPTR (gst_capsfilter_transform_caps);
120 trans_class->transform_ip = GST_DEBUG_FUNCPTR (gst_capsfilter_transform_ip);
121 trans_class->accept_caps = GST_DEBUG_FUNCPTR (gst_capsfilter_accept_caps);
122 trans_class->prepare_output_buffer =
123 GST_DEBUG_FUNCPTR (gst_capsfilter_prepare_buf);
127 gst_capsfilter_init (GstCapsFilter * filter)
129 GstBaseTransform *trans = GST_BASE_TRANSFORM (filter);
130 gst_base_transform_set_gap_aware (trans, TRUE);
131 filter->filter_caps = gst_caps_new_any ();
135 copy_func (GQuark field_id, const GValue * value, GstStructure * dest)
137 gst_structure_id_set_value (dest, field_id, value);
143 gst_capsfilter_set_property (GObject * object, guint prop_id,
144 const GValue * value, GParamSpec * pspec)
146 GstCapsFilter *capsfilter = GST_CAPSFILTER (object);
149 case PROP_FILTER_CAPS:{
151 GstCaps *old_caps, *suggest, *nego;
152 const GstCaps *new_caps_val = gst_value_get_caps (value);
154 if (new_caps_val == NULL) {
155 new_caps = gst_caps_new_any ();
157 new_caps = (GstCaps *) new_caps_val;
158 gst_caps_ref (new_caps);
161 GST_OBJECT_LOCK (capsfilter);
162 old_caps = capsfilter->filter_caps;
163 capsfilter->filter_caps = new_caps;
164 GST_OBJECT_UNLOCK (capsfilter);
166 gst_caps_unref (old_caps);
168 GST_DEBUG_OBJECT (capsfilter, "set new caps %" GST_PTR_FORMAT, new_caps);
170 /* filter the currently negotiated format against the new caps */
171 nego = gst_pad_get_current_caps (GST_BASE_TRANSFORM_SINK_PAD (object));
173 GST_DEBUG_OBJECT (capsfilter, "we had negotiated caps %" GST_PTR_FORMAT,
176 if (G_UNLIKELY (gst_caps_is_any (new_caps))) {
177 GST_DEBUG_OBJECT (capsfilter, "not settings any suggestion");
181 GstStructure *s1, *s2;
183 /* first check if the name is the same */
184 s1 = gst_caps_get_structure (nego, 0);
185 s2 = gst_caps_get_structure (new_caps, 0);
187 if (gst_structure_get_name_id (s1) == gst_structure_get_name_id (s2)) {
188 /* same name, copy all fields from the new caps into the previously
190 suggest = gst_caps_copy (nego);
191 s1 = gst_caps_get_structure (suggest, 0);
192 gst_structure_foreach (s2, (GstStructureForeachFunc) copy_func, s1);
193 GST_DEBUG_OBJECT (capsfilter, "copied structure fields");
195 GST_DEBUG_OBJECT (capsfilter, "different structure names");
196 /* different names, we can only suggest the complete caps */
197 suggest = gst_caps_copy (new_caps);
200 gst_caps_unref (nego);
202 GST_DEBUG_OBJECT (capsfilter, "no negotiated caps");
203 /* no previous caps, the getcaps function will be used to find suitable
208 GST_DEBUG_OBJECT (capsfilter, "suggesting new caps %" GST_PTR_FORMAT,
210 gst_base_transform_suggest (GST_BASE_TRANSFORM (object), suggest, 0);
212 gst_caps_unref (suggest);
217 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
223 gst_capsfilter_get_property (GObject * object, guint prop_id, GValue * value,
226 GstCapsFilter *capsfilter = GST_CAPSFILTER (object);
229 case PROP_FILTER_CAPS:
230 GST_OBJECT_LOCK (capsfilter);
231 gst_value_set_caps (value, capsfilter->filter_caps);
232 GST_OBJECT_UNLOCK (capsfilter);
235 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
241 gst_capsfilter_dispose (GObject * object)
243 GstCapsFilter *filter = GST_CAPSFILTER (object);
245 gst_caps_replace (&filter->filter_caps, NULL);
247 G_OBJECT_CLASS (parent_class)->dispose (object);
251 gst_capsfilter_transform_caps (GstBaseTransform * base,
252 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
254 GstCapsFilter *capsfilter = GST_CAPSFILTER (base);
255 GstCaps *ret, *filter_caps, *tmp;
257 GST_OBJECT_LOCK (capsfilter);
258 filter_caps = gst_caps_ref (capsfilter->filter_caps);
259 GST_OBJECT_UNLOCK (capsfilter);
263 gst_caps_intersect_full (filter, filter_caps, GST_CAPS_INTERSECT_FIRST);
264 gst_caps_unref (filter_caps);
268 ret = gst_caps_intersect_full (filter_caps, caps, GST_CAPS_INTERSECT_FIRST);
270 GST_DEBUG_OBJECT (capsfilter, "input: %" GST_PTR_FORMAT, caps);
271 GST_DEBUG_OBJECT (capsfilter, "filter: %" GST_PTR_FORMAT, filter);
272 GST_DEBUG_OBJECT (capsfilter, "caps filter: %" GST_PTR_FORMAT,
274 GST_DEBUG_OBJECT (capsfilter, "intersect: %" GST_PTR_FORMAT, ret);
276 gst_caps_unref (filter_caps);
282 gst_capsfilter_accept_caps (GstBaseTransform * base,
283 GstPadDirection direction, GstCaps * caps)
285 GstCapsFilter *capsfilter = GST_CAPSFILTER (base);
286 GstCaps *filter_caps;
289 GST_OBJECT_LOCK (capsfilter);
290 filter_caps = gst_caps_ref (capsfilter->filter_caps);
291 GST_OBJECT_UNLOCK (capsfilter);
293 ret = gst_caps_can_intersect (caps, filter_caps);
294 GST_DEBUG_OBJECT (capsfilter, "can intersect: %d", ret);
296 /* if we can intersect, see if the other end also accepts */
297 if (direction == GST_PAD_SRC)
298 ret = gst_pad_peer_accept_caps (GST_BASE_TRANSFORM_SINK_PAD (base), caps);
300 ret = gst_pad_peer_accept_caps (GST_BASE_TRANSFORM_SRC_PAD (base), caps);
301 GST_DEBUG_OBJECT (capsfilter, "peer accept: %d", ret);
304 gst_caps_unref (filter_caps);
310 gst_capsfilter_transform_ip (GstBaseTransform * base, GstBuffer * buf)
312 /* No actual work here. It's all done in the prepare output buffer
317 /* Output buffer preparation... if the buffer has no caps, and
318 * our allowed output caps is fixed, then give the caps to the
320 * This ensures that outgoing buffers have caps if we can, so
321 * that pipelines like:
322 * gst-launch filesrc location=rawsamples.raw !
323 * audio/x-raw-int,width=16,depth=16,rate=48000,channels=2,
324 * endianness=4321,signed='(boolean)'true ! alsasink
328 gst_capsfilter_prepare_buf (GstBaseTransform * trans, GstBuffer * input,
331 GstFlowReturn ret = GST_FLOW_OK;
333 /* always return the input as output buffer */
336 if (!gst_pad_has_current_caps (trans->sinkpad)) {
337 /* Buffer has no caps. See if the output pad only supports fixed caps */
340 GST_LOG_OBJECT (trans, "Input pad does not have caps");
342 out_caps = gst_pad_get_current_caps (trans->srcpad);
343 if (out_caps == NULL) {
344 out_caps = gst_pad_get_allowed_caps (trans->srcpad);
345 g_return_val_if_fail (out_caps != NULL, GST_FLOW_ERROR);
348 out_caps = gst_caps_make_writable (out_caps);
349 gst_caps_do_simplify (out_caps);
351 if (gst_caps_is_fixed (out_caps) && !gst_caps_is_empty (out_caps)) {
352 GST_DEBUG_OBJECT (trans, "Have fixed output caps %"
353 GST_PTR_FORMAT " to apply to srcpad", out_caps);
355 if (!gst_pad_has_current_caps (trans->srcpad))
356 gst_pad_push_event (trans->srcpad, gst_event_new_caps (out_caps));
358 gchar *caps_str = gst_caps_to_string (out_caps);
360 GST_DEBUG_OBJECT (trans, "Cannot choose caps. Have unfixed output caps %"
361 GST_PTR_FORMAT, out_caps);
362 gst_caps_unref (out_caps);
364 ret = GST_FLOW_ERROR;
365 GST_ELEMENT_ERROR (trans, STREAM, FORMAT,
366 ("Filter caps do not completely specify the output format"),
367 ("Output caps are unfixed: %s", caps_str));