2 * Copyright (C) 2006-2009 Mark Nauwelaerts <mnauw@users.sourceforge.net>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 * Boston, MA 02110-1307, USA.
21 * SECTION:element-capssetter
25 * Sets or merges caps on a stream's buffers.
26 * That is, a buffer's caps are updated using (fields of)
27 * <link linkend="GstCapsSetter--caps">caps</link>. Note that this may
28 * contain multiple structures (though not likely recommended), but each
29 * of these must be fixed (or will otherwise be rejected).
32 * If <link linkend="GstCapsSetter--join">join</link>
33 * is TRUE, then the incoming caps' mime-type is compared to the mime-type(s)
34 * of provided caps and only matching structure(s) are considered for updating.
37 * If <link linkend="GstCapsSetter--replace">replace</link>
38 * is TRUE, then any caps update is preceded by clearing existing fields,
39 * making provided fields (as a whole) replace incoming ones.
40 * Otherwise, no clearing is performed, in which case provided fields are
41 * added/merged onto incoming caps
44 * Although this element might mainly serve as debug helper,
45 * it can also practically be used to correct a faulty pixel-aspect-ratio,
46 * or to modify a yuv fourcc value to effectively swap chroma components or such
58 #include "gstcapssetter.h"
63 GST_DEBUG_CATEGORY_STATIC (caps_setter_debug);
64 #define GST_CAT_DEFAULT caps_setter_debug
67 /* signals and args */
83 #define DEFAULT_JOIN TRUE
84 #define DEFAULT_REPLACE FALSE
86 static GstStaticPadTemplate gst_caps_setter_src_template =
87 GST_STATIC_PAD_TEMPLATE (GST_BASE_TRANSFORM_SRC_NAME,
92 static GstStaticPadTemplate gst_caps_setter_sink_template =
93 GST_STATIC_PAD_TEMPLATE (GST_BASE_TRANSFORM_SINK_NAME,
99 static gboolean gst_caps_setter_transform_size (GstBaseTransform * trans,
100 GstPadDirection direction, GstCaps * caps, gsize size,
101 GstCaps * othercaps, gsize * othersize);
102 static GstCaps *gst_caps_setter_transform_caps (GstBaseTransform * trans,
103 GstPadDirection direction, GstCaps * caps, GstCaps * cfilter);
104 static GstFlowReturn gst_caps_setter_transform_ip (GstBaseTransform * btrans,
107 static void gst_caps_setter_finalize (GObject * object);
109 static void gst_caps_setter_set_property (GObject * object, guint prop_id,
110 const GValue * value, GParamSpec * pspec);
111 static void gst_caps_setter_get_property (GObject * object, guint prop_id,
112 GValue * value, GParamSpec * pspec);
114 #define gst_caps_setter_parent_class parent_class
115 G_DEFINE_TYPE (GstCapsSetter, gst_caps_setter, GST_TYPE_BASE_TRANSFORM);
118 gst_caps_setter_class_init (GstCapsSetterClass * g_class)
120 GObjectClass *gobject_class = (GObjectClass *) g_class;
121 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
122 GstBaseTransformClass *trans_class = (GstBaseTransformClass *) g_class;
124 GST_DEBUG_CATEGORY_INIT (caps_setter_debug, "capssetter", 0, "capssetter");
126 gobject_class->set_property = gst_caps_setter_set_property;
127 gobject_class->get_property = gst_caps_setter_get_property;
129 gobject_class->finalize = gst_caps_setter_finalize;
131 g_object_class_install_property (gobject_class, PROP_CAPS,
132 g_param_spec_boxed ("caps", "Merge caps",
133 "Merge these caps (thereby overwriting) in the stream",
134 GST_TYPE_CAPS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
135 g_object_class_install_property (gobject_class, PROP_JOIN,
136 g_param_spec_boolean ("join", "Join",
137 "Match incoming caps' mime-type to mime-type of provided caps",
138 DEFAULT_JOIN, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
139 g_object_class_install_property (gobject_class, PROP_REPLACE,
140 g_param_spec_boolean ("replace", "Replace",
141 "Drop fields of incoming caps", DEFAULT_REPLACE,
142 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
144 gst_element_class_set_static_metadata (element_class, "CapsSetter",
146 "Set/merge caps on stream",
147 "Mark Nauwelaerts <mnauw@users.sourceforge.net>");
149 gst_element_class_add_pad_template (element_class,
150 gst_static_pad_template_get (&gst_caps_setter_sink_template));
151 gst_element_class_add_pad_template (element_class,
152 gst_static_pad_template_get (&gst_caps_setter_src_template));
154 trans_class->transform_size =
155 GST_DEBUG_FUNCPTR (gst_caps_setter_transform_size);
156 trans_class->transform_caps =
157 GST_DEBUG_FUNCPTR (gst_caps_setter_transform_caps);
158 /* dummy seems needed */
159 trans_class->transform_ip = GST_DEBUG_FUNCPTR (gst_caps_setter_transform_ip);
163 gst_caps_setter_init (GstCapsSetter * filter)
165 filter->caps = gst_caps_new_any ();
166 filter->join = DEFAULT_JOIN;
167 filter->replace = DEFAULT_REPLACE;
171 gst_caps_setter_finalize (GObject * object)
173 GstCapsSetter *filter = GST_CAPS_SETTER (object);
175 gst_caps_replace (&filter->caps, NULL);
177 G_OBJECT_CLASS (parent_class)->finalize (object);
181 gst_caps_setter_transform_size (GstBaseTransform * trans,
182 GstPadDirection direction, GstCaps * caps, gsize size,
183 GstCaps * othercaps, gsize * othersize)
191 gst_caps_setter_transform_caps (GstBaseTransform * trans,
192 GstPadDirection direction, GstCaps * caps, GstCaps * cfilter)
194 GstCapsSetter *filter = GST_CAPS_SETTER (trans);
195 GstCaps *ret = NULL, *filter_caps = NULL;
196 GstStructure *structure, *merge;
200 GST_DEBUG_OBJECT (trans,
201 "receiving caps: %" GST_PTR_FORMAT ", with filter: %" GST_PTR_FORMAT,
204 /* pass filter caps upstream, or any if no filter */
205 if (direction != GST_PAD_SINK) {
206 if (!cfilter || gst_caps_is_empty (cfilter)) {
207 return gst_caps_ref (GST_CAPS_ANY);
209 return gst_caps_ref (cfilter);
213 ret = gst_caps_copy (caps);
215 /* this function is always called with a simple caps */
216 if (!GST_CAPS_IS_SIMPLE (ret))
219 structure = gst_caps_get_structure (ret, 0);
220 name = gst_structure_get_name (structure);
222 GST_OBJECT_LOCK (filter);
223 filter_caps = gst_caps_ref (filter->caps);
224 GST_OBJECT_UNLOCK (filter);
226 for (i = 0; i < gst_caps_get_size (filter_caps); ++i) {
227 merge = gst_caps_get_structure (filter_caps, i);
228 if (gst_structure_has_name (merge, name) || !filter->join) {
231 gst_structure_set_name (structure, gst_structure_get_name (merge));
234 gst_structure_remove_all_fields (structure);
236 for (j = 0; j < gst_structure_n_fields (merge); ++j) {
239 fname = gst_structure_nth_field_name (merge, j);
240 gst_structure_set_value (structure, fname,
241 gst_structure_get_value (merge, fname));
246 GST_DEBUG_OBJECT (trans, "returning caps: %" GST_PTR_FORMAT, ret);
248 gst_caps_unref (filter_caps);
254 gst_caps_setter_transform_ip (GstBaseTransform * btrans, GstBuffer * in)
260 gst_caps_is_fixed_foreach (GQuark field_id, const GValue * value,
263 return gst_value_is_fixed (value);
267 gst_caps_setter_set_property (GObject * object, guint prop_id,
268 const GValue * value, GParamSpec * pspec)
270 GstCapsSetter *filter = GST_CAPS_SETTER (object);
275 const GstCaps *new_caps_val = gst_value_get_caps (value);
278 if (new_caps_val == NULL) {
279 new_caps = gst_caps_new_any ();
281 new_caps = gst_caps_copy (new_caps_val);
284 for (i = 0; new_caps && (i < gst_caps_get_size (new_caps)); ++i) {
287 s = gst_caps_get_structure (new_caps, i);
288 if (!gst_structure_foreach (s, gst_caps_is_fixed_foreach, NULL)) {
289 GST_ERROR_OBJECT (filter, "rejected unfixed caps: %" GST_PTR_FORMAT,
291 gst_caps_unref (new_caps);
298 GST_OBJECT_LOCK (filter);
299 gst_caps_replace (&filter->caps, new_caps);
301 gst_caps_unref (new_caps);
302 GST_OBJECT_UNLOCK (filter);
304 GST_DEBUG_OBJECT (filter, "set new caps %" GST_PTR_FORMAT, new_caps);
307 /* try to activate these new caps next time around */
308 gst_base_transform_reconfigure_src (GST_BASE_TRANSFORM (filter));
312 filter->join = g_value_get_boolean (value);
315 filter->replace = g_value_get_boolean (value);
318 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
324 gst_caps_setter_get_property (GObject * object, guint prop_id, GValue * value,
327 GstCapsSetter *filter = GST_CAPS_SETTER (object);
331 gst_value_set_caps (value, filter->caps);
334 g_value_set_boolean (value, filter->join);
337 g_value_set_boolean (value, filter->replace);
340 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);