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_request_pad_by_name()
  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 base_init of the class:
  82  * <informalexample>
  83  *   <programlisting>
  84  *   static void
  85  *   my_element_base_init (gpointer g_class)
  86  *   {
  87  *     GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
  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   /* FIXME 0.11: Does anybody remember why this is here? If not, let's
 223    * change it for 0.11 and let gst_element_class_add_pad_template() for
 224    * example ref/sink the pad templates.
 225    */
 226   /* We ensure that the pad template we're creating has a sunken reference.
 227    * Inconsistencies in pad templates being floating or sunken has caused
 228    * problems in the past with leaks, etc.
 229    *
 230    * For consistency, then, we only produce them  with sunken references
 231    * owned by the creator of the object
 232    */
 233   if (GST_OBJECT_IS_FLOATING (templ)) {
 234     gst_object_ref (templ);
 235     gst_object_sink (templ);
 236   }
 237 }
 238
 239 static void
 240 gst_pad_template_dispose (GObject * object)
 241 {
 242   GstPadTemplate *templ = GST_PAD_TEMPLATE (object);
 243
 244   g_free (GST_PAD_TEMPLATE_NAME_TEMPLATE (templ));
 245   if (GST_PAD_TEMPLATE_CAPS (templ)) {
 246     gst_caps_unref (GST_PAD_TEMPLATE_CAPS (templ));
 247   }
 248
 249   G_OBJECT_CLASS (parent_class)->dispose (object);
 250 }
 251
 252 /* ALWAYS padtemplates cannot have conversion specifications (like src_%d),
 253  * since it doesn't make sense.
 254  * SOMETIMES padtemplates can do whatever they want, they are provided by the
 255  * element.
 256  * REQUEST padtemplates can be reverse-parsed (the user asks for 'sink1', the
 257  * 'sink%d' template is automatically selected), so we need to restrict their
 258  * naming.
 259  */
 260 static gboolean
 261 name_is_valid (const gchar * name, GstPadPresence presence)
 262 {
 263   const gchar *str;
 264
 265   if (presence == GST_PAD_ALWAYS) {
 266     if (strchr (name, '%')) {
 267       g_warning ("invalid name template %s: conversion specifications are not"
 268           " allowed for GST_PAD_ALWAYS padtemplates", name);
 269       return FALSE;
 270     }
 271   } else if (presence == GST_PAD_REQUEST) {
 272     if ((str = strchr (name, '%')) && strchr (str + 1, '%')) {
 273       g_warning ("invalid name template %s: only one conversion specification"
 274           " allowed in GST_PAD_REQUEST padtemplate", name);
 275       return FALSE;
 276     }
 277     if (str && (*(str + 1) != 's' && *(str + 1) != 'd' && *(str + 1) != 'u')) {
 278       g_warning ("invalid name template %s: conversion specification must be of"
 279           " type '%%d', '%%u' or '%%s' for GST_PAD_REQUEST padtemplate", name);
 280       return FALSE;
 281     }
 282     if (str && (*(str + 2) != '\0')) {
 283       g_warning ("invalid name template %s: conversion specification must"
 284           " appear at the end of the GST_PAD_REQUEST padtemplate name", name);
 285       return FALSE;
 286     }
 287   }
 288
 289   return TRUE;
 290 }
 291
 292 GType
 293 gst_static_pad_template_get_type (void)
 294 {
 295   static GType staticpadtemplate_type = 0;
 296
 297   if (G_UNLIKELY (staticpadtemplate_type == 0)) {
 298     staticpadtemplate_type =
 299         g_pointer_type_register_static ("GstStaticPadTemplate");
 300   }
 301   return staticpadtemplate_type;
 302 }
 303
 304 /**
 305  * gst_static_pad_template_get:
 306  * @pad_template: the static pad template
 307  *
 308  * Converts a #GstStaticPadTemplate into a #GstPadTemplate.
 309  *
 310  * Returns: a new #GstPadTemplate.
 311  */
 312 GstPadTemplate *
 313 gst_static_pad_template_get (GstStaticPadTemplate * pad_template)
 314 {
 315   GstPadTemplate *new;
 316   GstCaps *caps;
 317
 318   if (!name_is_valid (pad_template->name_template, pad_template->presence))
 319     return NULL;
 320
 321   caps = gst_static_caps_get (&pad_template->static_caps);
 322
 323   new = g_object_new (gst_pad_template_get_type (),
 324       "name", pad_template->name_template,
 325       "name-template", pad_template->name_template,
 326       "direction", pad_template->direction,
 327       "presence", pad_template->presence, "caps", caps, NULL);
 328
 329   gst_caps_unref (caps);
 330
 331   return new;
 332 }
 333
 334 /**
 335  * gst_pad_template_new:
 336  * @name_template: the name template.
 337  * @direction: the #GstPadDirection of the template.
 338  * @presence: the #GstPadPresence of the pad.
 339  * @caps: a #GstCaps set for the template. The caps are taken ownership of.
 340  *
 341  * Creates a new pad template with a name according to the given template
 342  * and with the given arguments. This functions takes ownership of the provided
 343  * caps, so be sure to not use them afterwards.
 344  *
 345  * Returns: a new #GstPadTemplate.
 346  */
 347 GstPadTemplate *
 348 gst_pad_template_new (const gchar * name_template,
 349     GstPadDirection direction, GstPadPresence presence, GstCaps * caps)
 350 {
 351   GstPadTemplate *new;
 352
 353   g_return_val_if_fail (name_template != NULL, NULL);
 354   g_return_val_if_fail (caps != NULL, NULL);
 355   g_return_val_if_fail (direction == GST_PAD_SRC
 356       || direction == GST_PAD_SINK, NULL);
 357   g_return_val_if_fail (presence == GST_PAD_ALWAYS
 358       || presence == GST_PAD_SOMETIMES || presence == GST_PAD_REQUEST, NULL);
 359
 360   if (!name_is_valid (name_template, presence)) {
 361     gst_caps_unref (caps);
 362     return NULL;
 363   }
 364
 365   new = g_object_new (gst_pad_template_get_type (),
 366       "name", name_template, "name-template", name_template,
 367       "direction", direction, "presence", presence, "caps", caps, NULL);
 368
 369 #if 0
 370   /* FIXME: enable this after gst-ffmpeg-0.10.6 and
 371    * gst-plugins-good-0.10.11 have been released.  Previous versions
 372    * depend on broken core behavior. */
 373   if (caps)
 374     gst_caps_unref (caps);
 375 #endif
 376
 377   return new;
 378 }
 379
 380 /**
 381  * gst_static_pad_template_get_caps:
 382  * @templ: a #GstStaticPadTemplate to get capabilities of.
 383  *
 384  * Gets the capabilities of the static pad template.
 385  *
 386  * Returns: the #GstCaps of the static pad template. If you need to keep a
 387  * reference to the caps, take a ref (see gst_caps_ref ()).
 388  */
 389 GstCaps *
 390 gst_static_pad_template_get_caps (GstStaticPadTemplate * templ)
 391 {
 392   g_return_val_if_fail (templ, NULL);
 393
 394   return (GstCaps *) gst_static_caps_get (&templ->static_caps);
 395 }
 396
 397 /**
 398  * gst_pad_template_get_caps:
 399  * @templ: a #GstPadTemplate to get capabilities of.
 400  *
 401  * Gets the capabilities of the pad template.
 402  *
 403  * Returns: the #GstCaps of the pad template. If you need to keep a reference to
 404  * the caps, take a ref (see gst_caps_ref ()).
 405  */
 406 GstCaps *
 407 gst_pad_template_get_caps (GstPadTemplate * templ)
 408 {
 409   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 410
 411   return GST_PAD_TEMPLATE_CAPS (templ);
 412 }
 413
 414 /**
 415  * gst_pad_template_pad_created:
 416  * @templ: a #GstPadTemplate that has been created
 417  * @pad:   the #GstPad that created it
 418  *
 419  * Emit the pad-created signal for this template when created by this pad.
 420  */
 421 void
 422 gst_pad_template_pad_created (GstPadTemplate * templ, GstPad * pad)
 423 {
 424   g_signal_emit (G_OBJECT (templ),
 425       gst_pad_template_signals[TEMPL_PAD_CREATED], 0, pad);
 426 }
 427
 428 static void
 429 gst_pad_template_set_property (GObject * object, guint prop_id,
 430     const GValue * value, GParamSpec * pspec)
 431 {
 432   /* these properties are all construct-only */
 433   switch (prop_id) {
 434     case PROP_NAME_TEMPLATE:
 435       GST_PAD_TEMPLATE_NAME_TEMPLATE (object) = g_value_dup_string (value);
 436       break;
 437     case PROP_DIRECTION:
 438       GST_PAD_TEMPLATE_DIRECTION (object) = g_value_get_enum (value);
 439       break;
 440     case PROP_PRESENCE:
 441       GST_PAD_TEMPLATE_PRESENCE (object) = g_value_get_enum (value);
 442       break;
 443     case PROP_CAPS:
 444       /* allow caps == NULL for backwards compatibility (ie. g_object_new()
 445        * called without any of the new properties) (FIXME 0.11) */
 446       if (g_value_get_boxed (value) != NULL) {
 447         GST_PAD_TEMPLATE_CAPS (object) =
 448             gst_caps_copy (g_value_get_boxed (value));
 449       }
 450       break;
 451     default:
 452       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 453       break;
 454   }
 455 }
 456
 457 static void
 458 gst_pad_template_get_property (GObject * object, guint prop_id, GValue * value,
 459     GParamSpec * pspec)
 460 {
 461   /* these properties are all construct-only */
 462   switch (prop_id) {
 463     case PROP_NAME_TEMPLATE:
 464       g_value_set_string (value, GST_PAD_TEMPLATE_NAME_TEMPLATE (object));
 465       break;
 466     case PROP_DIRECTION:
 467       g_value_set_enum (value, GST_PAD_TEMPLATE_DIRECTION (object));
 468       break;
 469     case PROP_PRESENCE:
 470       g_value_set_enum (value, GST_PAD_TEMPLATE_PRESENCE (object));
 471       break;
 472     case PROP_CAPS:
 473       g_value_set_boxed (value, GST_PAD_TEMPLATE_CAPS (object));
 474       break;
 475     default:
 476       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 477       break;
 478   }
 479 }