gst/gstpadtemplate.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstpadtemplate.c: Templates for pad creation
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 /**
  24  * SECTION:gstpadtemplate
  25  * @short_description: Describe the media type of a pad.
  26  * @see_also: #GstPad, #GstElementFactory
  27  *
  28  * Padtemplates describe the possible media types a pad or an elementfactory can
  29  * handle. This allows for both inspection of handled types before loading the
  30  * element plugin as well as identifying pads on elements that are not yet
  31  * created (request or sometimes pads).
  32  *
  33  * Pad and PadTemplates have #GstCaps attached to it to describe the media type
  34  * they are capable of dealing with. gst_pad_template_get_caps() or
  35  * GST_PAD_TEMPLATE_CAPS() are used to get the caps of a padtemplate. It's not
  36  * possible to modify the caps of a padtemplate after creation.
  37  *
  38  * PadTemplates have a #GstPadPresence property which identifies the lifetime
  39  * of the pad and that can be retrieved with GST_PAD_TEMPLATE_PRESENCE(). Also
  40  * the direction of the pad can be retrieved from the #GstPadTemplate with
  41  * GST_PAD_TEMPLATE_DIRECTION().
  42  *
  43  * The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads
  44  * because it has to be used as the name in the gst_element_get_request_pad()
  45  * call to instantiate a pad from this template.
  46  *
  47  * Padtemplates can be created with gst_pad_template_new() or with
  48  * gst_static_pad_template_get (), which creates a #GstPadTemplate from a
  49  * #GstStaticPadTemplate that can be filled with the
  50  * convenient GST_STATIC_PAD_TEMPLATE() macro.
  51  *
  52  * A padtemplate can be used to create a pad (see gst_pad_new_from_template()
  53  * or gst_pad_new_from_static_template ()) or to add to an element class
  54  * (see gst_element_class_add_pad_template ()).
  55  *
  56  * The following code example shows the code to create a pad from a padtemplate.
  57  * <example>
  58  * <title>Create a pad from a padtemplate</title>
  59  *   <programlisting>
  60  *   GstStaticPadTemplate my_template =
  61  *   GST_STATIC_PAD_TEMPLATE (
  62  *     "sink",          // the name of the pad
  63  *     GST_PAD_SINK,    // the direction of the pad
  64  *     GST_PAD_ALWAYS,  // when this pad will be present
  65  *     GST_STATIC_CAPS (        // the capabilities of the padtemplate
  66  *       "audio/x-raw-int, "
  67  *         "channels = (int) [ 1, 6 ]"
  68  *     )
  69  *   );
  70  *   void
  71  *   my_method (void)
  72  *   {
  73  *     GstPad *pad;
  74  *     pad = gst_pad_new_from_static_template (&amp;my_template, "sink");
  75  *     ...
  76  *   }
  77  *   </programlisting>
  78  * </example>
  79  *
  80  * The following example shows you how to add the padtemplate to an
  81  * element class, this is usually done in the class_init of the class:
  82  * <informalexample>
  83  *   <programlisting>
  84  *   static void
  85  *   my_element_class_init (GstMyElementClass *klass)
  86  *   {
  87  *     GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
  88  *
  89  *     gst_element_class_add_pad_template (gstelement_class,
  90  *         gst_static_pad_template_get (&amp;my_template));
  91  *   }
  92  *   </programlisting>
  93  * </informalexample>
  94  *
  95  * Last reviewed on 2006-02-14 (0.10.3)
  96  */
  97
  98 #include "gst_private.h"
  99
 100 #include "gstpad.h"
 101 #include "gstpadtemplate.h"
 102 #include "gstenumtypes.h"
 103 #include "gstmarshal.h"
 104 #include "gstutils.h"
 105 #include "gstinfo.h"
 106 #include "gsterror.h"
 107 #include "gstvalue.h"
 108
 109 #define GST_CAT_DEFAULT GST_CAT_PADS
 110
 111 enum
 112 {
 113   PROP_NAME_TEMPLATE = 1,
 114   PROP_DIRECTION,
 115   PROP_PRESENCE,
 116   PROP_CAPS
 117 };
 118
 119 enum
 120 {
 121   TEMPL_PAD_CREATED,
 122   /* FILL ME */
 123   LAST_SIGNAL
 124 };
 125
 126 static GstObject *parent_class = NULL;
 127 static guint gst_pad_template_signals[LAST_SIGNAL] = { 0 };
 128
 129 static void gst_pad_template_dispose (GObject * object);
 130 static void gst_pad_template_set_property (GObject * object, guint prop_id,
 131     const GValue * value, GParamSpec * pspec);
 132 static void gst_pad_template_get_property (GObject * object, guint prop_id,
 133     GValue * value, GParamSpec * pspec);
 134
 135 G_DEFINE_TYPE (GstPadTemplate, gst_pad_template, GST_TYPE_OBJECT);
 136
 137 static void
 138 gst_pad_template_class_init (GstPadTemplateClass * klass)
 139 {
 140   GObjectClass *gobject_class;
 141   GstObjectClass *gstobject_class;
 142
 143   gobject_class = (GObjectClass *) klass;
 144   gstobject_class = (GstObjectClass *) klass;
 145
 146   parent_class = g_type_class_peek_parent (klass);
 147
 148   /**
 149    * GstPadTemplate::pad-created:
 150    * @pad_template: the object which received the signal.
 151    * @pad: the pad that was created.
 152    *
 153    * This signal is fired when an element creates a pad from this template.
 154    */
 155   gst_pad_template_signals[TEMPL_PAD_CREATED] =
 156       g_signal_new ("pad-created", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 157       G_STRUCT_OFFSET (GstPadTemplateClass, pad_created),
 158       NULL, NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
 159
 160   gobject_class->dispose = gst_pad_template_dispose;
 161
 162   gobject_class->get_property = gst_pad_template_get_property;
 163   gobject_class->set_property = gst_pad_template_set_property;
 164
 165   /**
 166    * GstPadTemplate:name-template
 167    *
 168    * The name template of the pad template.
 169    *
 170    * Since: 0.10.21
 171    */
 172   g_object_class_install_property (gobject_class, PROP_NAME_TEMPLATE,
 173       g_param_spec_string ("name-template", "Name template",
 174           "The name template of the pad template", NULL,
 175           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 176
 177   /**
 178    * GstPadTemplate:direction
 179    *
 180    * The direction of the pad described by the pad template.
 181    *
 182    * Since: 0.10.21
 183    */
 184   g_object_class_install_property (gobject_class, PROP_DIRECTION,
 185       g_param_spec_enum ("direction", "Direction",
 186           "The direction of the pad described by the pad template",
 187           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
 188           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 189
 190   /**
 191    * GstPadTemplate:presence
 192    *
 193    * When the pad described by the pad template will become available.
 194    *
 195    * Since: 0.10.21
 196    */
 197   g_object_class_install_property (gobject_class, PROP_PRESENCE,
 198       g_param_spec_enum ("presence", "Presence",
 199           "When the pad described by the pad template will become available",
 200           GST_TYPE_PAD_PRESENCE, GST_PAD_ALWAYS,
 201           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 202
 203   /**
 204    * GstPadTemplate:caps
 205    *
 206    * The capabilities of the pad described by the pad template.
 207    *
 208    * Since: 0.10.21
 209    */
 210   g_object_class_install_property (gobject_class, PROP_CAPS,
 211       g_param_spec_boxed ("caps", "Caps",
 212           "The capabilities of the pad described by the pad template",
 213           GST_TYPE_CAPS,
 214           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 215
 216   gstobject_class->path_string_separator = "*";
 217 }
 218
 219 static void
 220 gst_pad_template_init (GstPadTemplate * templ)
 221 {
 222 }
 223
 224 static void
 225 gst_pad_template_dispose (GObject * object)
 226 {
 227   GstPadTemplate *templ = GST_PAD_TEMPLATE (object);
 228
 229   g_free (GST_PAD_TEMPLATE_NAME_TEMPLATE (templ));
 230   if (GST_PAD_TEMPLATE_CAPS (templ)) {
 231     gst_caps_unref (GST_PAD_TEMPLATE_CAPS (templ));
 232   }
 233
 234   G_OBJECT_CLASS (parent_class)->dispose (object);
 235 }
 236
 237 /* ALWAYS padtemplates cannot have conversion specifications (like src_%d),
 238  * since it doesn't make sense.
 239  * SOMETIMES padtemplates can do whatever they want, they are provided by the
 240  * element.
 241  * REQUEST padtemplates can be reverse-parsed (the user asks for 'sink1', the
 242  * 'sink%d' template is automatically selected), so we need to restrict their
 243  * naming.
 244  */
 245 static gboolean
 246 name_is_valid (const gchar * name, GstPadPresence presence)
 247 {
 248   const gchar *str;
 249
 250   if (presence == GST_PAD_ALWAYS) {
 251     if (strchr (name, '%')) {
 252       g_warning ("invalid name template %s: conversion specifications are not"
 253           " allowed for GST_PAD_ALWAYS padtemplates", name);
 254       return FALSE;
 255     }
 256   } else if (presence == GST_PAD_REQUEST) {
 257     if ((str = strchr (name, '%')) && strchr (str + 1, '%')) {
 258       g_warning ("invalid name template %s: only one conversion specification"
 259           " allowed in GST_PAD_REQUEST padtemplate", name);
 260       return FALSE;
 261     }
 262     if (str && (*(str + 1) != 's' && *(str + 1) != 'd' && *(str + 1) != 'u')) {
 263       g_warning ("invalid name template %s: conversion specification must be of"
 264           " type '%%d', '%%u' or '%%s' for GST_PAD_REQUEST padtemplate", name);
 265       return FALSE;
 266     }
 267     if (str && (*(str + 2) != '\0')) {
 268       g_warning ("invalid name template %s: conversion specification must"
 269           " appear at the end of the GST_PAD_REQUEST padtemplate name", name);
 270       return FALSE;
 271     }
 272   }
 273
 274   return TRUE;
 275 }
 276
 277 GType
 278 gst_static_pad_template_get_type (void)
 279 {
 280   static GType staticpadtemplate_type = 0;
 281
 282   if (G_UNLIKELY (staticpadtemplate_type == 0)) {
 283     staticpadtemplate_type =
 284         g_pointer_type_register_static ("GstStaticPadTemplate");
 285   }
 286   return staticpadtemplate_type;
 287 }
 288
 289 /**
 290  * gst_static_pad_template_get:
 291  * @pad_template: the static pad template
 292  *
 293  * Converts a #GstStaticPadTemplate into a #GstPadTemplate.
 294  *
 295  * Returns: (transfer full): a new #GstPadTemplate.
 296  */
 297 /* FIXME0.11: rename to gst_pad_template_new_from_static_pad_template() */
 298 GstPadTemplate *
 299 gst_static_pad_template_get (GstStaticPadTemplate * pad_template)
 300 {
 301   GstPadTemplate *new;
 302   GstCaps *caps;
 303
 304   if (!name_is_valid (pad_template->name_template, pad_template->presence))
 305     return NULL;
 306
 307   caps = gst_static_caps_get (&pad_template->static_caps);
 308
 309   new = g_object_new (gst_pad_template_get_type (),
 310       "name", pad_template->name_template,
 311       "name-template", pad_template->name_template,
 312       "direction", pad_template->direction,
 313       "presence", pad_template->presence, "caps", caps, NULL);
 314
 315   gst_caps_unref (caps);
 316
 317   return new;
 318 }
 319
 320 /**
 321  * gst_pad_template_new:
 322  * @name_template: the name template.
 323  * @direction: the #GstPadDirection of the template.
 324  * @presence: the #GstPadPresence of the pad.
 325  * @caps: a #GstCaps set for the template.
 326  *
 327  * Creates a new pad template with a name according to the given template
 328  * and with the given arguments.
 329  *
 330  * Returns: (transfer full): a new #GstPadTemplate.
 331  */
 332 GstPadTemplate *
 333 gst_pad_template_new (const gchar * name_template,
 334     GstPadDirection direction, GstPadPresence presence, GstCaps * caps)
 335 {
 336   GstPadTemplate *new;
 337
 338   g_return_val_if_fail (name_template != NULL, NULL);
 339   g_return_val_if_fail (caps != NULL, NULL);
 340   g_return_val_if_fail (direction == GST_PAD_SRC
 341       || direction == GST_PAD_SINK, NULL);
 342   g_return_val_if_fail (presence == GST_PAD_ALWAYS
 343       || presence == GST_PAD_SOMETIMES || presence == GST_PAD_REQUEST, NULL);
 344
 345   if (!name_is_valid (name_template, presence)) {
 346     return NULL;
 347   }
 348
 349   new = g_object_new (gst_pad_template_get_type (),
 350       "name", name_template, "name-template", name_template,
 351       "direction", direction, "presence", presence, "caps", caps, NULL);
 352
 353   return new;
 354 }
 355
 356 /**
 357  * gst_static_pad_template_get_caps:
 358  * @templ: a #GstStaticPadTemplate to get capabilities of.
 359  *
 360  * Gets the capabilities of the static pad template.
 361  *
 362  * Returns: (transfer full): the #GstCaps of the static pad template.
 363  * Unref after usage. Since the core holds an additional
 364  * ref to the returned caps, use gst_caps_make_writable()
 365  * on the returned caps to modify it.
 366  */
 367 GstCaps *
 368 gst_static_pad_template_get_caps (GstStaticPadTemplate * templ)
 369 {
 370   g_return_val_if_fail (templ, NULL);
 371
 372   return (GstCaps *) gst_static_caps_get (&templ->static_caps);
 373 }
 374
 375 /**
 376  * gst_pad_template_get_caps:
 377  * @templ: a #GstPadTemplate to get capabilities of.
 378  *
 379  * Gets the capabilities of the pad template.
 380  *
 381  * Returns: (transfer full): the #GstCaps of the pad template.
 382  * Unref after usage.
 383  */
 384 GstCaps *
 385 gst_pad_template_get_caps (GstPadTemplate * templ)
 386 {
 387   GstCaps *caps;
 388   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 389
 390   caps = GST_PAD_TEMPLATE_CAPS (templ);
 391
 392   return (caps ? gst_caps_ref (caps) : NULL);
 393 }
 394
 395 /**
 396  * gst_pad_template_pad_created:
 397  * @templ: a #GstPadTemplate that has been created
 398  * @pad:   the #GstPad that created it
 399  *
 400  * Emit the pad-created signal for this template when created by this pad.
 401  */
 402 void
 403 gst_pad_template_pad_created (GstPadTemplate * templ, GstPad * pad)
 404 {
 405   g_signal_emit (templ, gst_pad_template_signals[TEMPL_PAD_CREATED], 0, pad);
 406 }
 407
 408 static void
 409 gst_pad_template_set_property (GObject * object, guint prop_id,
 410     const GValue * value, GParamSpec * pspec)
 411 {
 412   /* these properties are all construct-only */
 413   switch (prop_id) {
 414     case PROP_NAME_TEMPLATE:
 415       GST_PAD_TEMPLATE_NAME_TEMPLATE (object) = g_value_dup_string (value);
 416       break;
 417     case PROP_DIRECTION:
 418       GST_PAD_TEMPLATE_DIRECTION (object) =
 419           (GstPadDirection) g_value_get_enum (value);
 420       break;
 421     case PROP_PRESENCE:
 422       GST_PAD_TEMPLATE_PRESENCE (object) =
 423           (GstPadPresence) g_value_get_enum (value);
 424       break;
 425     case PROP_CAPS:
 426       GST_PAD_TEMPLATE_CAPS (object) = g_value_dup_boxed (value);
 427       break;
 428     default:
 429       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 430       break;
 431   }
 432 }
 433
 434 static void
 435 gst_pad_template_get_property (GObject * object, guint prop_id, GValue * value,
 436     GParamSpec * pspec)
 437 {
 438   /* these properties are all construct-only */
 439   switch (prop_id) {
 440     case PROP_NAME_TEMPLATE:
 441       g_value_set_string (value, GST_PAD_TEMPLATE_NAME_TEMPLATE (object));
 442       break;
 443     case PROP_DIRECTION:
 444       g_value_set_enum (value, GST_PAD_TEMPLATE_DIRECTION (object));
 445       break;
 446     case PROP_PRESENCE:
 447       g_value_set_enum (value, GST_PAD_TEMPLATE_PRESENCE (object));
 448       break;
 449     case PROP_CAPS:
 450       g_value_set_boxed (value, GST_PAD_TEMPLATE_CAPS (object));
 451       break;
 452     default:
 453       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 454       break;
 455   }
 456 }