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);
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, gint size, GstCaps * caps, 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 GST_OBJECT_LOCK (GST_BASE_TRANSFORM_SINK_PAD (object));
172 nego = GST_PAD_CAPS (GST_BASE_TRANSFORM_SINK_PAD (object));
174 GST_DEBUG_OBJECT (capsfilter, "we had negotiated caps %" GST_PTR_FORMAT,
177 if (G_UNLIKELY (gst_caps_is_any (new_caps))) {
178 GST_DEBUG_OBJECT (capsfilter, "not settings any suggestion");
182 GstStructure *s1, *s2;
184 /* first check if the name is the same */
185 s1 = gst_caps_get_structure (nego, 0);
186 s2 = gst_caps_get_structure (new_caps, 0);
188 if (gst_structure_get_name_id (s1) == gst_structure_get_name_id (s2)) {
189 /* same name, copy all fields from the new caps into the previously
191 suggest = gst_caps_copy (nego);
192 s1 = gst_caps_get_structure (suggest, 0);
193 gst_structure_foreach (s2, (GstStructureForeachFunc) copy_func, s1);
194 GST_DEBUG_OBJECT (capsfilter, "copied structure fields");
196 GST_DEBUG_OBJECT (capsfilter, "different structure names");
197 /* different names, we can only suggest the complete caps */
198 suggest = gst_caps_copy (new_caps);
202 GST_DEBUG_OBJECT (capsfilter, "no negotiated caps");
203 /* no previous caps, the getcaps function will be used to find suitable
207 GST_OBJECT_UNLOCK (GST_BASE_TRANSFORM_SINK_PAD (object));
209 GST_DEBUG_OBJECT (capsfilter, "suggesting new caps %" GST_PTR_FORMAT,
211 gst_base_transform_suggest (GST_BASE_TRANSFORM (object), suggest, 0);
213 gst_caps_unref (suggest);
218 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
224 gst_capsfilter_get_property (GObject * object, guint prop_id, GValue * value,
227 GstCapsFilter *capsfilter = GST_CAPSFILTER (object);
230 case PROP_FILTER_CAPS:
231 GST_OBJECT_LOCK (capsfilter);
232 gst_value_set_caps (value, capsfilter->filter_caps);
233 GST_OBJECT_UNLOCK (capsfilter);
236 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
242 gst_capsfilter_dispose (GObject * object)
244 GstCapsFilter *filter = GST_CAPSFILTER (object);
246 gst_caps_replace (&filter->filter_caps, NULL);
248 G_OBJECT_CLASS (parent_class)->dispose (object);
252 gst_capsfilter_transform_caps (GstBaseTransform * base,
253 GstPadDirection direction, GstCaps * caps)
255 GstCapsFilter *capsfilter = GST_CAPSFILTER (base);
256 GstCaps *ret, *filter_caps;
258 GST_OBJECT_LOCK (capsfilter);
259 filter_caps = gst_caps_ref (capsfilter->filter_caps);
260 GST_OBJECT_UNLOCK (capsfilter);
262 ret = gst_caps_intersect (caps, filter_caps);
263 GST_DEBUG_OBJECT (capsfilter, "input: %" GST_PTR_FORMAT, caps);
264 GST_DEBUG_OBJECT (capsfilter, "filter: %" GST_PTR_FORMAT, filter_caps);
265 GST_DEBUG_OBJECT (capsfilter, "intersect: %" GST_PTR_FORMAT, ret);
267 gst_caps_unref (filter_caps);
273 gst_capsfilter_accept_caps (GstBaseTransform * base,
274 GstPadDirection direction, GstCaps * caps)
276 GstCapsFilter *capsfilter = GST_CAPSFILTER (base);
277 GstCaps *filter_caps;
280 GST_OBJECT_LOCK (capsfilter);
281 filter_caps = gst_caps_ref (capsfilter->filter_caps);
282 GST_OBJECT_UNLOCK (capsfilter);
284 ret = gst_caps_can_intersect (caps, filter_caps);
285 GST_DEBUG_OBJECT (capsfilter, "can intersect: %d", ret);
287 /* if we can intersect, see if the other end also accepts */
288 if (direction == GST_PAD_SRC)
289 ret = gst_pad_peer_accept_caps (GST_BASE_TRANSFORM_SINK_PAD (base), caps);
291 ret = gst_pad_peer_accept_caps (GST_BASE_TRANSFORM_SRC_PAD (base), caps);
292 GST_DEBUG_OBJECT (capsfilter, "peer accept: %d", ret);
295 gst_caps_unref (filter_caps);
301 gst_capsfilter_transform_ip (GstBaseTransform * base, GstBuffer * buf)
303 /* No actual work here. It's all done in the prepare output buffer
308 /* Output buffer preparation... if the buffer has no caps, and
309 * our allowed output caps is fixed, then give the caps to the
311 * This ensures that outgoing buffers have caps if we can, so
312 * that pipelines like:
313 * gst-launch filesrc location=rawsamples.raw !
314 * audio/x-raw-int,width=16,depth=16,rate=48000,channels=2,
315 * endianness=4321,signed='(boolean)'true ! alsasink
319 gst_capsfilter_prepare_buf (GstBaseTransform * trans, GstBuffer * input,
320 gint size, GstCaps * caps, GstBuffer ** buf)
322 GstFlowReturn ret = GST_FLOW_OK;
324 if (GST_BUFFER_CAPS (input) != NULL) {
325 /* Output buffer already has caps */
326 GST_LOG_OBJECT (trans, "Input buffer already has caps (implicitely fixed)");
327 /* FIXME : Move this behaviour to basetransform. The given caps are the ones
328 * of the source pad, therefore our outgoing buffers should always have
330 if (GST_BUFFER_CAPS (input) != caps) {
331 /* caps are different, make a metadata writable output buffer to set
333 if (gst_buffer_is_writable (input)) {
334 /* input is writable, just set caps and use this as the output */
336 gst_buffer_set_caps (*buf, caps);
337 gst_buffer_ref (input);
339 GST_DEBUG_OBJECT (trans, "Creating sub-buffer and setting caps");
340 *buf = gst_buffer_copy (input);
341 gst_buffer_set_caps (*buf, caps);
344 /* caps are right, just use a ref of the input as the outbuf */
346 gst_buffer_ref (input);
349 /* Buffer has no caps. See if the output pad only supports fixed caps */
352 out_caps = GST_PAD_CAPS (trans->srcpad);
354 if (out_caps != NULL) {
355 gst_caps_ref (out_caps);
357 out_caps = gst_pad_get_allowed_caps (trans->srcpad);
358 g_return_val_if_fail (out_caps != NULL, GST_FLOW_ERROR);
361 out_caps = gst_caps_make_writable (out_caps);
362 gst_caps_do_simplify (out_caps);
364 if (gst_caps_is_fixed (out_caps) && !gst_caps_is_empty (out_caps)) {
365 GST_DEBUG_OBJECT (trans, "Have fixed output caps %"
366 GST_PTR_FORMAT " to apply to buffer with no caps", out_caps);
367 if (gst_buffer_is_writable (input)) {
368 gst_buffer_ref (input);
371 GST_DEBUG_OBJECT (trans, "Creating sub-buffer and setting caps");
372 *buf = gst_buffer_copy (input);
374 GST_BUFFER_CAPS (*buf) = out_caps;
376 if (GST_PAD_CAPS (trans->srcpad) == NULL)
377 gst_pad_set_caps (trans->srcpad, out_caps);
379 gchar *caps_str = gst_caps_to_string (out_caps);
381 GST_DEBUG_OBJECT (trans, "Cannot choose caps. Have unfixed output caps %"
382 GST_PTR_FORMAT, out_caps);
383 gst_caps_unref (out_caps);
385 ret = GST_FLOW_ERROR;
386 GST_ELEMENT_ERROR (trans, STREAM, FORMAT,
387 ("Filter caps do not completely specify the output format"),
388 ("Output caps are unfixed: %s", caps_str));