gst/debugutils/gstcapssetter.c

   1 /* GStreamer Element
   2  * Copyright (C) 2006-2009 Mark Nauwelaerts <mnauw@users.sourceforge.net>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /**
  21  * SECTION:element-capssetter
  22  *
  23  * <refsect2>
  24  * <para>
  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).
  30  * </para>
  31  * <para>
  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.
  35  * </para>
  36  * <para>
  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
  42  * </para>
  43  * <para>
  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
  47  * alike.
  48  * </para>
  49  * </refsect2>
  50  *
  51  */
  52
  53
  54 #ifdef HAVE_CONFIG_H
  55 #include "config.h"
  56 #endif
  57
  58 #include "gstcapssetter.h"
  59
  60 #include <string.h>
  61
  62
  63 GST_DEBUG_CATEGORY_STATIC (caps_setter_debug);
  64 #define GST_CAT_DEFAULT caps_setter_debug
  65
  66
  67 /* signals and args */
  68 enum
  69 {
  70   /* FILL ME */
  71   LAST_SIGNAL
  72 };
  73
  74 enum
  75 {
  76   PROP_0,
  77   PROP_CAPS,
  78   PROP_JOIN,
  79   PROP_REPLACE
  80       /* FILL ME */
  81 };
  82
  83 #define DEFAULT_JOIN              TRUE
  84 #define DEFAULT_REPLACE           FALSE
  85
  86 static GstStaticPadTemplate gst_caps_setter_src_template =
  87 GST_STATIC_PAD_TEMPLATE (GST_BASE_TRANSFORM_SRC_NAME,
  88     GST_PAD_SRC,
  89     GST_PAD_ALWAYS,
  90     GST_STATIC_CAPS_ANY);
  91
  92 static GstStaticPadTemplate gst_caps_setter_sink_template =
  93 GST_STATIC_PAD_TEMPLATE (GST_BASE_TRANSFORM_SINK_NAME,
  94     GST_PAD_SINK,
  95     GST_PAD_ALWAYS,
  96     GST_STATIC_CAPS_ANY);
  97
  98
  99 static gboolean gst_caps_setter_transform_size (GstBaseTransform * trans,
 100     GstPadDirection direction, GstCaps * caps, guint size,
 101     GstCaps * othercaps, guint * othersize);
 102 static GstCaps *gst_caps_setter_transform_caps (GstBaseTransform * trans,
 103     GstPadDirection direction, GstCaps * caps);
 104 static GstFlowReturn gst_caps_setter_transform_ip (GstBaseTransform * btrans,
 105     GstBuffer * in);
 106
 107 static void gst_caps_setter_finalize (GObject * object);
 108
 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);
 113
 114 GST_BOILERPLATE (GstCapsSetter, gst_caps_setter, GstBaseTransform,
 115     GST_TYPE_BASE_TRANSFORM);
 116
 117 static void
 118 gst_caps_setter_base_init (gpointer g_class)
 119 {
 120   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 121
 122   gst_element_class_set_details_simple (element_class, "CapsSetter",
 123       "Generic",
 124       "Set/merge caps on stream",
 125       "Mark Nauwelaerts <mnauw@users.sourceforge.net>");
 126
 127   gst_element_class_add_pad_template (element_class,
 128       gst_static_pad_template_get (&gst_caps_setter_sink_template));
 129   gst_element_class_add_pad_template (element_class,
 130       gst_static_pad_template_get (&gst_caps_setter_src_template));
 131 }
 132
 133 static void
 134 gst_caps_setter_class_init (GstCapsSetterClass * g_class)
 135 {
 136   GObjectClass *gobject_class;
 137   GstBaseTransformClass *trans_class;
 138
 139   gobject_class = G_OBJECT_CLASS (g_class);
 140   trans_class = GST_BASE_TRANSFORM_CLASS (g_class);
 141
 142   GST_DEBUG_CATEGORY_INIT (caps_setter_debug, "capssetter", 0, "capssetter");
 143
 144   gobject_class->set_property = gst_caps_setter_set_property;
 145   gobject_class->get_property = gst_caps_setter_get_property;
 146
 147   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_caps_setter_finalize);
 148
 149   g_object_class_install_property (gobject_class, PROP_CAPS,
 150       g_param_spec_boxed ("caps", "Merge caps",
 151           "Merge these caps (thereby overwriting) in the stream",
 152           GST_TYPE_CAPS, G_PARAM_READWRITE));
 153   g_object_class_install_property (gobject_class, PROP_JOIN,
 154       g_param_spec_boolean ("join", "Join",
 155           "Match incoming caps' mime-type to mime-type of provided caps",
 156           DEFAULT_JOIN, G_PARAM_READWRITE));
 157   g_object_class_install_property (gobject_class, PROP_REPLACE,
 158       g_param_spec_boolean ("replace", "Replace",
 159           "Drop fields of incoming caps", DEFAULT_REPLACE, G_PARAM_READWRITE));
 160
 161   trans_class->transform_size =
 162       GST_DEBUG_FUNCPTR (gst_caps_setter_transform_size);
 163   trans_class->transform_caps =
 164       GST_DEBUG_FUNCPTR (gst_caps_setter_transform_caps);
 165   /* dummy seems needed */
 166   trans_class->transform_ip = GST_DEBUG_FUNCPTR (gst_caps_setter_transform_ip);
 167 }
 168
 169 static void
 170 gst_caps_setter_init (GstCapsSetter * filter, GstCapsSetterClass * g_class)
 171 {
 172   filter->caps = gst_caps_new_any ();
 173   filter->join = DEFAULT_JOIN;
 174   filter->replace = DEFAULT_REPLACE;
 175 }
 176
 177 static void
 178 gst_caps_setter_finalize (GObject * object)
 179 {
 180   GstCapsSetter *filter = GST_CAPS_SETTER (object);
 181
 182   gst_caps_replace (&filter->caps, NULL);
 183
 184   G_OBJECT_CLASS (parent_class)->finalize (object);
 185 }
 186
 187 static gboolean
 188 gst_caps_setter_transform_size (GstBaseTransform * trans,
 189     GstPadDirection direction, GstCaps * caps, guint size,
 190     GstCaps * othercaps, guint * othersize)
 191 {
 192   *othersize = size;
 193
 194   return TRUE;
 195 }
 196
 197 static GstCaps *
 198 gst_caps_setter_transform_caps (GstBaseTransform * trans,
 199     GstPadDirection direction, GstCaps * caps)
 200 {
 201   GstCapsSetter *filter;
 202   GstCaps *ret, *filter_caps;
 203   GstStructure *structure, *merge;
 204   const gchar *name;
 205   gint i, j;
 206
 207   filter = GST_CAPS_SETTER (trans);
 208
 209   GST_DEBUG_OBJECT (trans, "receiving caps: %" GST_PTR_FORMAT, caps);
 210
 211   ret = gst_caps_copy (caps);
 212
 213   /* this function is always called with a simple caps */
 214   if (!GST_CAPS_IS_SIMPLE (ret) || direction != GST_PAD_SINK)
 215     return ret;
 216
 217   structure = gst_caps_get_structure (ret, 0);
 218   name = gst_structure_get_name (structure);
 219
 220   GST_OBJECT_LOCK (filter);
 221   filter_caps = gst_caps_ref (filter->caps);
 222   GST_OBJECT_UNLOCK (filter);
 223
 224   for (i = 0; i < gst_caps_get_size (filter_caps); ++i) {
 225     merge = gst_caps_get_structure (filter_caps, i);
 226     if (gst_structure_has_name (merge, name) || !filter->join) {
 227
 228       if (!filter->join)
 229         gst_structure_set_name (structure, gst_structure_get_name (merge));
 230
 231       if (filter->replace)
 232         gst_structure_remove_all_fields (structure);
 233
 234       for (j = 0; j < gst_structure_n_fields (merge); ++j) {
 235         const gchar *fname;
 236
 237         fname = gst_structure_nth_field_name (merge, j);
 238         gst_structure_set_value (structure, fname,
 239             gst_structure_get_value (merge, fname));
 240       }
 241     }
 242   }
 243
 244   GST_DEBUG_OBJECT (trans, "returning caps: %" GST_PTR_FORMAT, ret);
 245
 246   gst_caps_unref (filter_caps);
 247
 248   return ret;
 249 }
 250
 251 static GstFlowReturn
 252 gst_caps_setter_transform_ip (GstBaseTransform * btrans, GstBuffer * in)
 253 {
 254   return GST_FLOW_OK;
 255 }
 256
 257 static gboolean
 258 gst_caps_is_fixed_foreach (GQuark field_id, const GValue * value,
 259     gpointer unused)
 260 {
 261   return gst_value_is_fixed (value);
 262 }
 263
 264 static void
 265 gst_caps_setter_set_property (GObject * object, guint prop_id,
 266     const GValue * value, GParamSpec * pspec)
 267 {
 268   GstCapsSetter *filter;
 269
 270   g_return_if_fail (GST_IS_CAPS_SETTER (object));
 271   filter = GST_CAPS_SETTER (object);
 272
 273   switch (prop_id) {
 274     case PROP_CAPS:{
 275       GstCaps *new_caps;
 276       const GstCaps *new_caps_val = gst_value_get_caps (value);
 277       gint i;
 278
 279       if (new_caps_val == NULL) {
 280         new_caps = gst_caps_new_any ();
 281       } else {
 282         new_caps = gst_caps_copy (new_caps_val);
 283       }
 284
 285       for (i = 0; new_caps && (i < gst_caps_get_size (new_caps)); ++i) {
 286         GstStructure *s;
 287
 288         s = gst_caps_get_structure (new_caps, i);
 289         if (!gst_structure_foreach (s, gst_caps_is_fixed_foreach, NULL)) {
 290           GST_ERROR_OBJECT (filter, "rejected unfixed caps: %" GST_PTR_FORMAT,
 291               new_caps);
 292           gst_caps_unref (new_caps);
 293           new_caps = NULL;
 294           break;
 295         }
 296       }
 297
 298       if (new_caps) {
 299         GST_OBJECT_LOCK (filter);
 300         gst_caps_replace (&filter->caps, new_caps);
 301         /* drop extra ref */
 302         gst_caps_unref (new_caps);
 303         GST_OBJECT_UNLOCK (filter);
 304
 305         GST_DEBUG_OBJECT (filter, "set new caps %" GST_PTR_FORMAT, new_caps);
 306       }
 307
 308       /* try to activate these new caps next time around */
 309       gst_base_transform_reconfigure (GST_BASE_TRANSFORM (filter));
 310       break;
 311     }
 312     case PROP_JOIN:
 313       filter->join = g_value_get_boolean (value);
 314       break;
 315     case PROP_REPLACE:
 316       filter->replace = g_value_get_boolean (value);
 317       break;
 318     default:
 319       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 320       break;
 321   }
 322 }
 323
 324 static void
 325 gst_caps_setter_get_property (GObject * object, guint prop_id, GValue * value,
 326     GParamSpec * pspec)
 327 {
 328   GstCapsSetter *filter;
 329
 330   g_return_if_fail (GST_IS_CAPS_SETTER (object));
 331   filter = GST_CAPS_SETTER (object);
 332
 333   switch (prop_id) {
 334     case PROP_CAPS:
 335       gst_value_set_caps (value, filter->caps);
 336       break;
 337     case PROP_JOIN:
 338       g_value_set_boolean (value, filter->join);
 339       break;
 340     case PROP_REPLACE:
 341       g_value_set_boolean (value, filter->replace);
 342       break;
 343     default:
 344       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 345       break;
 346   }
 347 }